UnitedKingdom

addMapColor(array $colorCodeArray) _v5

Add colors to a map
PARAMETERS:
$colorCodeArray = array, An array of hexa color codes to apply to the loaded map object
RETURN VALUE:
void

addStateAmount(string $stateAbbr, int $amount) _v5

Add stats amount to US map
PARAMETERS:
$stateAbbr = string, State name as 2 letter code
$amount = int, stats amount for the selected state
RETURN VALUE:
void

getEastEnglandArray() _v5

Gets UK east England region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK east England region cities as an array of 3 letters city code

getEastMidlandsArray() _v5

Gets UK east mid-lands region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK east mid-lands region cities as an array of 3 letters city code

getHoverHTML() _v5

Gets map hover HTML
PARAMETERS:
NONE
RETURN VALUE:
string = map hover HTML

getLegendHTML() _v5

Gets map legend as HTML
PARAMETERS:
NONE
RETURN VALUE:
string = map legend as HTML

getMap() _v5

Gets map SVG content
PARAMETERS:
NONE
RETURN VALUE:
string = map content as SVG

getNorthEastArray() _v5

Gets UK north east region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK north east region cities as an array of 3 letters city code

getNorthIrelandArray() _v5

Gets UK North Ireland region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK North Ireland region cities as an array of 3 letters city code

getNorthWestArray() _v5

Gets UK north west region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK north west region cities as an array of 3 letters city code

getRecordsLabel() _v5

Gets map record label
PARAMETERS:
NONE
RETURN VALUE:
string = map record label

getRegion(string $county) _v5

Gets any region in a country
PARAMETERS:
$county = country name as 2 letters
RETURN VALUE:
string = region area name

getScotlandArray() _v5

Gets UK Scotland region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK Scotland region cities as an array of 3 letters city code

getSouthEastArray() _v5

Gets UK south east region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK south east region cities as an array of 3 letters city code

getSouthWestArray() _v5

Gets UK south west region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK south west region cities as an array of 3 letters city code

getStateColors(int $amount) _v5

Get states colors based on the stats amount
PARAMETERS:
$amount = int, stats amount per state
RETURN VALUE:
string = states colors based on the stats amount

getStateHoverColors(int $amount) _v5

Get states hover colors based on the stats amount
PARAMETERS:
$amount = int, stats amount per state
RETURN VALUE:
string = states hover colors based on the stats amount

getStatesTable() _v5

Gets map states table as HTML
PARAMETERS:
NONE
RETURN VALUE:
string = map states table as HTML

getTableTR() _v5

Get map record as HTML
PARAMETERS:
NONE
RETURN VALUE:
string = map record as HTML

getURL() _v5

Get map URL
PARAMETERS:
NONE
RETURN VALUE:
string = Map URL

getWalesArray() _v5

Gets UK Wales region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK Wales region cities as an array of 3 letters city code

getWestMidlandsArray() _v5

Gets UK west mid-lands region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK west mid-lands region cities as an array of 3 letters city code

getYorkshireArray() _v5

Gets UK Yorkshire region cities as an array
PARAMETERS:
NONE
RETURN VALUE:
Array = UK Yorkshire region cities as an array of 3 letters city code

hideLegend() _v5

hide map legend
PARAMETERS:
NONE
RETURN VALUE:
void

setHoverHTML(string $hoverHTML) _v5

Set map hover HTML template
PARAMETERS:
$hoverHTML = string, map hover HTML template
RETURN VALUE:
void

setLegendHTML(string $legendHTML) _v5

Set map legend HTML template
PARAMETERS:
$legendHTML = string, Map legend HTML template
RETURN VALUE:
void

setRecordsLabel(string $recordsLabel) _v5

Set map records label
PARAMETERS:
$recordsLabel = string, Record label
RETURN VALUE:
void

setTableTR(string $tableTR) _v5

Set map table row HTML template
PARAMETERS:
$tableTR = string, map table record HTML template
RETURN VALUE:
void

setURL(string $url) _v5

Set map URL
PARAMETERS:
$url = string, Map URL
RETURN VALUE:
void

showLegend() _v5

Show map legend
PARAMETERS:
NONE
RETURN VALUE:
void