Scroll to navigation

Tirex::Map(3pm) User Contributed Perl Documentation Tirex::Map(3pm)

NAME

Tirex::Map - A Tirex map configuration

SYNOPSIS

my $map = Tirex::Map->new();

DESCRIPTION

A Tirex map configuration. It always contains the name, tile directory and zoom range for this map. Depending on the backend there can be more options.

METHODS

Tirex::Map->get('foo')

Get map by name.

Tirex::Map->clear();

Clear list of maps.

Tirex::Map->get_map_for_metatile($metatile)

Get map for a metatile.

Will croak if the map named in the metatile does not exist. Will also croak if the zoom given in the metatile is out of range.

Tirex::Map->new( ... )

Create new map configuration.

Default values for minimum zoom (minz) is 0, for maximum zoom (maxz) it's 17.

Tirex::Map->new_from_configfile($filename, $renderer)

Create new map config from a file for a given renderer.

Croaks if the file does not exist.

$map->get_name()

Get name of this map.

$map->get_renderer()

Get renderer of this map.

$map->get_filename()

Get filename of config file for this map. This only works if the map was created from a config file. Otherwise it will return undef.

$map->get_tiledir()

Get tile directory of this map.

$map->get_minz()

Get minimum zoom value of this map.

$map->get_maxz()

Get maximum zoom of this map.

$map->to_s();

Return human readable description of this map.

$map->to_hash();

Return parameters of this map as hash.

Tirex::Map->status();

Return status of all configured maps.

2024-08-28 perl v5.38.2