Online Maps  v3
OnlineMapsProvider.MapType Class Reference

Class of map type More...

Public Member Functions

 MapType (string title)
 Constructor More...
 
 MapType (string id, string title)
 Constructor More...
 
string GetURL (OnlineMapsTile tile)
 Gets the URL to download the tile texture More...
 

Public Attributes

readonly string id
 ID of map type More...
 
readonly string title
 Human-readable map type title. More...
 
OnlineMapsProvider provider
 Reference to provider instance. More...
 
int index
 Index of map type More...
 
bool isCustom
 Indicates that this is an custom provider. More...
 

Properties

string ext [get, set]
 Extension. Token {ext}, that is being replaced in the URL. More...
 
bool hasLanguage [get, set]
 Indicates that the map type supports multilanguage. More...
 
bool hasLabels [get, set]
 Indicates that the provider supports a map with labels. More...
 
bool labelsEnabled [get, set]
 Indicates that the label is always enabled. More...
 
string propWithLabels [get, set]
 Property. Token {prop} when label enabled, that is being replaced in the URL. More...
 
string propWithoutLabels [get, set]
 Property. Token {prop} when label disabled, that is being replaced in the URL. More...
 
string? prop2 [get, set]
 Property. Token {prop2}, that is being replaced in the URL. More...
 
string variant [set]
 Variant. Token {variant}, that is being replaced in the URL. More...
 
string variantWithLabels [get, set]
 Variant. Token {variant} when label enabled, that is being replaced in the URL. More...
 
string variantWithoutLabels [get, set]
 Variant. Token {variant} when label disabled, that is being replaced in the URL. More...
 
string urlWithLabels [get, set]
 Gets / sets the URL pattern of tiles with labels. More...
 
string urlWithoutLabels [get, set]
 Gets / sets the URL pattern of tiles without labels. More...
 
bool useHTTP [get, set]
 Indicates that the map type uses HTTP. More...
 
string this[string token] [get, set]
 Gets or sets the value of the extra field. More...
 

Detailed Description

Class of map type

Constructor & Destructor Documentation

◆ MapType() [1/2]

OnlineMapsProvider.MapType.MapType ( string  title)

Constructor

Parameters
titleHuman-readable map type title.

◆ MapType() [2/2]

OnlineMapsProvider.MapType.MapType ( string  id,
string  title 
)

Constructor

Parameters
idID of map type.
titleHuman-readable map type title.

Member Function Documentation

◆ GetURL()

string OnlineMapsProvider.MapType.GetURL ( OnlineMapsTile  tile)

Gets the URL to download the tile texture

Parameters
tileInstance of tile
Returns
URL to tile texture

Member Data Documentation

◆ id

readonly string OnlineMapsProvider.MapType.id

ID of map type

◆ index

int OnlineMapsProvider.MapType.index

Index of map type

◆ isCustom

bool OnlineMapsProvider.MapType.isCustom

Indicates that this is an custom provider.

◆ provider

OnlineMapsProvider OnlineMapsProvider.MapType.provider

Reference to provider instance.

◆ title

readonly string OnlineMapsProvider.MapType.title

Human-readable map type title.

Property Documentation

◆ ext

string OnlineMapsProvider.MapType.ext
getset

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

◆ hasLabels

bool OnlineMapsProvider.MapType.hasLabels
getset

Indicates that the provider supports a map with labels.

◆ hasLanguage

bool OnlineMapsProvider.MapType.hasLanguage
getset

Indicates that the map type supports multilanguage.

◆ labelsEnabled

bool OnlineMapsProvider.MapType.labelsEnabled
getset

Indicates that the label is always enabled.

◆ prop2

string? OnlineMapsProvider.MapType.prop2
getset

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

◆ propWithLabels

string OnlineMapsProvider.MapType.propWithLabels
getset

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

◆ propWithoutLabels

string OnlineMapsProvider.MapType.propWithoutLabels
getset

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

◆ this[string token]

string OnlineMapsProvider.MapType.this[string token]
getset

Gets or sets the value of the extra field.

Parameters
tokenToken (ID) of the extra field.

◆ urlWithLabels

string OnlineMapsProvider.MapType.urlWithLabels
getset

Gets / sets the URL pattern of tiles with labels.

◆ urlWithoutLabels

string OnlineMapsProvider.MapType.urlWithoutLabels
getset

Gets / sets the URL pattern of tiles without labels.

◆ useHTTP

bool OnlineMapsProvider.MapType.useHTTP
getset

Indicates that the map type uses HTTP.

◆ variant

string OnlineMapsProvider.MapType.variant
set

Variant. Token {variant}, that is being replaced in the URL.

◆ variantWithLabels

string OnlineMapsProvider.MapType.variantWithLabels
getset

Variant. Token {variant} when label enabled, that is being replaced in the URL.

◆ variantWithoutLabels

string OnlineMapsProvider.MapType.variantWithoutLabels
getset

Variant. Token {variant} when label disabled, that is being replaced in the URL.