[ Whereis® API Home ] [ JSON API Home ] [ Object Index ] [ Mapping Types ]

Defines an image that can be overlaid on a map. Currently, all <icon> types are partially pre-defined by EMS.

For a full list of available icons, refer to the Appendix. See <marker> to position an icon on the map.

Format

{
	"colour": <string>,
	"colour1" : <string>,
	"colour2" : <string>,
	"text": <string>,
	"textColour": <string>,
	"type": <string>
}

Parameters

Name

Mandatory?

Description

type

Y

May be one of "standard", "poi", "multi", and "babushka".

If "type" is “standard”:

  • "text" must be one of the prescribed values
  • "colour" and "textColour" are ignored.

colour

N

May be one of “purple”, “green”, or “brown”.

All EMS icons are shaded from one colour to another but if “colour” is specified, the shading is preset.

If colour, colour1 and colour2 are all specified, the value specified for “colour” takes precedence

colour1

N

String value submitted as RGB in hex format, e.g. "#FF8844".

Icon colour is shaded from top to bottom. colour1 specifies the base colour.

colour2

N

String value submitted as RGB in hex format, e.g. "#FF8844".

Specifies the highlight colour.

To create an icon with a ‘flat’ colour, specify the same value at ”colour1” and “colour2”.

text

N

Text to appear on the icon. For readability, should not exceed 3 characters for a poi, one character for multipoi or babushka.

If “type” is “standard”:

  • "text" must be one of “start”,” via1”, “via2”, “via3”, “via4”, “via5”, “end”, or “cross_hairs”
  • Default = “cross_hairs”.

textColour

N

String value submitted as RGB in hex format, e.g. "#FF8844"

 

 

NOTES

Though specified in the “text” field, “cross_hairs” does not appear on the icon