Map Layout

Basic Options

Visible

Default Value: true

Type: boolean

Documentation: Sets the default visibility of the base layers.

Path: layout.geo.visible


Layout and Positioning

Lat (latitude)

Type: number

Documentation: Sets the latitude of the map's center. For all projection types, the map's latitude center lies at the middle of the latitude range by default.

Path: layout.geo.center.lat

Lon (longitude)

Type: number

Documentation: Sets the longitude of the map's center. By default, the map's longitude center lies at the middle of the longitude range for scoped projection and above projection.rotation.lon otherwise.

Path: layout.geo.center.lon

Type

Type: enumerated

Enum Options: airy,aitoff,albers,albers usa,august,azimuthal equal area,azimuthal equidistant,baker,bertin1953,boggs,bonne,bottomley,bromley,collignon,conic conformal,conic equal area,conic equidistant,craig,craster,cylindrical equal area,cylindrical stereographic,eckert1,eckert2,eckert3,eckert4,eckert5,eckert6,eisenlohr,equal earth,equirectangular,fahey,foucaut,foucaut sinusoidal,ginzburg4,ginzburg5,ginzburg6,ginzburg8,ginzburg9,gnomonic,gringorten,gringorten quincuncial,guyou,hammer,hill,homolosine,hufnagel,hyperelliptical,kavrayskiy7,lagrange,larrivee,laskowski,loximuthal,mercator,miller,mollweide,mt flat polar parabolic,mt flat polar quartic,mt flat polar sinusoidal,natural earth,natural earth1,natural earth2,nell hammer,nicolosi,orthographic,patterson,peirce quincuncial,polyconic,rectangular polyconic,robinson,satellite,sinu mollweide,sinusoidal,stereographic,times,transverse mercator,van der grinten,van der grinten2,van der grinten3,van der grinten4,wagner4,wagner6,wiechel,winkel tripel,winkel3

Documentation: Sets the projection type.

Path: layout.geo.projection.type

Resolution

Default Value: 110

Type: enumerated

Enum Options: 110,50

Documentation: Sets the resolution of the base layers. The values have units of km/mm e.g. 110 corresponds to a scale ratio of 1:110,000,000.

Path: layout.geo.resolution

Scope

Default Value: world

Type: enumerated

Enum Options: africa,asia,europe,north america,south america,usa,world

Documentation: Set the scope of the map.

Path: layout.geo.scope


Map Objects Options

Bg Color

Default Value: #fff

Type: color

Documentation: Set the background color of the map

Path: layout.geo.bgcolor

Coastline Color

Default Value: #444

Type: color

Documentation: Sets the coastline color.

Path: layout.geo.coastlinecolor

Coastline Width

Default Value: 1

Type: number

Min: 0

Documentation: Sets the coastline stroke width (in px).

Path: layout.geo.coastlinewidth

Country Color

Default Value: #444

Type: color

Documentation: Sets line color of the country boundaries.

Path: layout.geo.countrycolor

Country Width

Default Value: 1

Type: number

Min: 0

Documentation: Sets line width (in px) of the country boundaries.

Path: layout.geo.countrywidth

Frame Color

Default Value: #444

Type: color

Documentation: Sets the color the frame.

Path: layout.geo.framecolor

Frame Width

Default Value: 1

Type: number

Min: 0

Documentation: Sets the stroke width (in px) of the frame.

Path: layout.geo.framewidth

Lake Color

Default Value: #3399FF

Type: color

Documentation: Sets the color of the lakes.

Path: layout.geo.lakecolor

Land Color

Default Value: #F0DC82

Type: color

Documentation: Sets the land mass color.

Path: layout.geo.landcolor

Ocean Color

Default Value: #3399FF

Type: color

Documentation: Sets the ocean color

Path: layout.geo.oceancolor

River Color

Default Value: #3399FF

Type: color

Documentation: Sets color of the rivers.

Path: layout.geo.rivercolor

River Width

Default Value: 1

Type: number

Min: 0

Documentation: Sets the stroke width (in px) of the rivers.

Path: layout.geo.riverwidth

Show Coastlines

Type: boolean

Documentation: Sets whether or not the coastlines are drawn.

Path: layout.geo.showcoastlines

Show Countries

Type: boolean

Documentation: Sets whether or not country boundaries are drawn.

Path: layout.geo.showcountries

Show Frame

Type: boolean

Documentation: Sets whether or not a frame is drawn around the map.

Path: layout.geo.showframe

Show Lakes

Default Value: false

Type: boolean

Documentation: Sets whether or not lakes are drawn.

Path: layout.geo.showlakes

Show Land

Default Value: false

Type: boolean

Documentation: Sets whether or not land masses are filled in color.

Path: layout.geo.showland

Show Ocean

Default Value: false

Type: boolean

Documentation: Sets whether or not oceans are filled in color.

Path: layout.geo.showocean

Show Rivers

Default Value: false

Type: boolean

Documentation: Sets whether or not rivers are drawn.

Path: layout.geo.showrivers

Show Subunits

Type: boolean

Documentation: Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn.

Path: layout.geo.showsubunits

Subunit Color

Default Value: #444

Type: color

Documentation: Sets the color of the subunits boundaries.

Path: layout.geo.subunitcolor

Subunit Width

Default Value: 1

Type: number

Min: 0

Documentation: Sets the stroke width (in px) of the subunits boundaries.

Path: layout.geo.subunitwidth


Last updated