OnlineMapsProvider Class Reference

Provider of tiles. More...

Classes
class	ExtraField
	Class for extra field. More...
interface	IExtraField
	Interface for extra fields tile provider. More...
class	MapType
	Class of map type. More...
class	ToggleExtraGroup
	Group of toggle extra fields. More...

Public Member Functions
void	AppendTypes (params MapType[] newTypes)
	Appends map types to the provider.
MapType	CreateType (string title)
	Creates a new map type with the specified title.
MapType	CreateType (string id, string title)
	Creates a new map type with the specified ID and title.
MapType	GetByIndex (int index, bool repeat=false)
	Gets map type by index.

Static Public Member Functions
static OnlineMapsProvider	Create (string title)
	Creates a new provider, with the specified title.
static MapType	CreateMapType (string id)
	Creates a new map type, with the specified id.
static MapType	CreateMapType (string id, string url)
	Creates a new map type, with the specified id.
static MapType	FindMapType (string mapTypeID)
	Gets an instance of a map type by ID. ID - providerID or providerID(dot)typeID. If the typeID is not specified returns the first map type of provider. If the provider ID is not found, returns the first map type of the first provider. Example: nokia or google.satellite.
static OnlineMapsProvider	Get (string id)
	Get provider by ID.
static OnlineMapsProvider[]	GetProviders ()
	Gets array of providers.
static string[]	GetProvidersTitle ()
	Gets array of provider titles.

Public Attributes
readonly string	id
	ID of provider.
readonly string	title
	Human-readable provider title.
bool?	hasLanguage
	Indicates that the provider supports multilanguage.
bool?	hasLabels
	Indicates that the provider supports a map with labels.
bool?	labelsEnabled
	Indicates that the label is always enabled.
OnlineMapsProjection	projection
	Map projection.
bool?	useHTTP
	Indicates that the provider uses HTTP.
int	index
	Index of current provider.
string	ext
	Extension. Token {ext}, that is being replaced in the URL.
string	prop
	Property. Token {prop}, that is being replaced in the URL.
string	prop2
	Property. Token {prop2}, that is being replaced in the URL.
bool	twoLetterLanguage = true
	Indicates that the provider uses two letter language code.

Properties
MapType[]	types [get]
	Array of map types available for the current provider.
string	url [get, set]
	Gets / sets the URL pattern of tiles.

Detailed Description

Provider of tiles.

Member Function Documentation

AppendTypes()

void OnlineMapsProvider.AppendTypes

(

params MapType[]

newTypes

)

Appends map types to the provider.

Parameters

newTypes

Map types

Create()

static OnlineMapsProvider OnlineMapsProvider.Create ( string title )

static

Creates a new provider, with the specified title.

Parameters

title

Provider title. Provider id = title.ToLower().

Returns

Instance of provider.

CreateMapType() [1/2]

static MapType OnlineMapsProvider.CreateMapType ( string id )

static

Creates a new map type, with the specified id.

Parameters

id	Map type ID. Format: providerID.mapTypeID

Returns

Instance of map type.

CreateMapType() [2/2]

static MapType OnlineMapsProvider.CreateMapType ( string id, string url )

static

Creates a new map type, with the specified id.

Parameters

id	Map type ID. Format: providerID.mapTypeID
url	URL of the map type.

Returns

Instance of map type.

CreateType() [1/2]

MapType OnlineMapsProvider.CreateType	(	string	id,
		string	title )

Creates a new map type with the specified ID and title.

Parameters

id	ID of the map type.
title	Title of the map type.

Returns

A new instance of the map type.

CreateType() [2/2]

MapType OnlineMapsProvider.CreateType

(

string

title

)

Creates a new map type with the specified title.

Parameters

title

Title of the map type. The ID of the map type is derived from the title by converting it to lowercase.

Returns

A new instance of the map type.

FindMapType()

static MapType OnlineMapsProvider.FindMapType ( string mapTypeID )

static

Gets an instance of a map type by ID.
ID - providerID or providerID(dot)typeID.
If the typeID is not specified returns the first map type of provider.
If the provider ID is not found, returns the first map type of the first provider.
Example: nokia or google.satellite.

Parameters

mapTypeID

Map type ID.

Returns

Instance of map type

Get()

static OnlineMapsProvider OnlineMapsProvider.Get ( string id )

static

Get provider by ID.

Parameters

id	Provider ID

Returns

Provider or null

GetByIndex()

MapType OnlineMapsProvider.GetByIndex	(	int	index,
		bool	repeat = false )

Gets map type by index.

Parameters

index	Index of map type.
repeat	TRUE - Repeat index value, FALSE - Clamp index value.

Returns

Instance of map type.

GetProviders()

static OnlineMapsProvider[] OnlineMapsProvider.GetProviders ( )

static

Gets array of providers.

Returns

Array of providers

GetProvidersTitle()

static string[] OnlineMapsProvider.GetProvidersTitle ( )

static

Gets array of provider titles.

Returns

Array of provider titles