Online Maps  v3
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. More...
 
MapType GetByIndex (int index, bool repeat=false)
 Gets map type by index. More...
 

Static Public Member Functions

static OnlineMapsProvider Create (string title)
 Creates a new provider, with the specified title. More...
 
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 More...
 
static OnlineMapsProvider [] GetProviders ()
 Gets array of providers More...
 
static string [] GetProvidersTitle ()
 Gets array of provider titles. More...
 

Public Attributes

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

Properties

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

Detailed Description

Provider of tiles.

Member Function Documentation

◆ AppendTypes()

void OnlineMapsProvider.AppendTypes ( params MapType []  newTypes)

Appends map types to the provider.

Parameters
newTypesMap types

◆ Create()

static OnlineMapsProvider OnlineMapsProvider.Create ( string  title)
static

Creates a new provider, with the specified title.

Parameters
titleProvider title. Provider id = title.ToLower().
Returns
Instance of provider.

◆ 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
mapTypeIDID of map type
Returns
Instance of map type

◆ GetByIndex()

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

Gets map type by index.

Parameters
indexIndex of map type.
repeatTRUE - 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

Member Data Documentation

◆ ext

string OnlineMapsProvider.ext

Extension. Token {ext}, that is being replaced in the URL.

◆ hasLabels

bool? OnlineMapsProvider.hasLabels

Indicates that the provider supports a map with labels.

◆ hasLanguage

bool? OnlineMapsProvider.hasLanguage

Indicates that the provider supports multilanguage.

◆ id

readonly string OnlineMapsProvider.id

ID of provider

◆ index

int OnlineMapsProvider.index

Index of current provider.

◆ labelsEnabled

bool? OnlineMapsProvider.labelsEnabled

Indicates that the label is always enabled.

◆ projection

OnlineMapsProjection OnlineMapsProvider.projection

Map projection.

◆ prop

string OnlineMapsProvider.prop

Property. Token {prop}, that is being replaced in the URL.

◆ prop2

string OnlineMapsProvider.prop2

Property. Token {prop2}, that is being replaced in the URL.

◆ title

readonly string OnlineMapsProvider.title

Human-readable provider title.

◆ twoLetterLanguage

bool OnlineMapsProvider.twoLetterLanguage = true

Indicates that the provider uses two letter language code.

◆ useHTTP

bool? OnlineMapsProvider.useHTTP

Indicates that the provider uses HTTP.

Property Documentation

◆ types

MapType [] OnlineMapsProvider.types
get

Array of map types available for the current provider.

◆ url

string OnlineMapsProvider.url
getset

Gets / sets the URL pattern of tiles.