org.fujion.gmaps

Class MapTypeStyleOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.gmaps.MapTypeStyleOptions

All Implemented Interfaces:

IOptionMapTransform, IClientTransform

public class MapTypeStyleOptions
extends Options

A collection of selectors and stylers that define how the map should be styled. Selectors specify the map features and/or elements that should be affected, and stylers specify how those features and elements should be modified. Usage details may be found here.

Field Summary

Fields

Modifier and Type	Field and Description
String	elementType The element to which a styler should be applied.
String	featureType The feature, or group of features, to which a styler should be applied.
List<Styler<?>>	stylers The style rules to apply to the selected map features and elements.

Constructor Summary

Constructors

Constructor and Description
MapTypeStyleOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.IOptionMapTransform

transformForClient

Field Detail

elementType

@Option
public String elementType

The element to which a styler should be applied. An element is a visual aspect of a feature on the map. Example: a label, an icon, the stroke or fill applied to the geometry, and more. Optional. If elementType is not specified, the value is assumed to be 'all'.

Elements are subdivisions of a feature. A road, for example, consists of the graphical line (the geometry) on the map, and also the text denoting its name (a label). The following elements are available, but note that a specific feature may support none, some, or all, of the elements:

• all (default) selects all elements of the specified feature.
• geometry selects all geometric elements of the specified feature.
• geometry.fill selects only the fill of the feature's geometry.
• geometry.stroke selects only the stroke of the feature's geometry.
• labels selects the textual labels associated with the specified feature.
• labels.icon selects only the icon displayed within the feature's label.
• labels.text selects only the text of the label.
• labels.text.fill selects only the fill of the label. The fill of a label is typically rendered as a colored outline that surrounds the label text.
• labels.text.stroke selects only the stroke of the label's text.

featureType

@Option
public String featureType

The feature, or group of features, to which a styler should be applied. Optional. If featureType is not specified, the value is assumed to be 'all'.

Features, or feature types, are geographic characteristics on the map, including roads, parks, bodies of water, businesses, and more. The features form a category tree, with all as the root. If you don't specify a feature, all features are selected. Specifying a feature of all has the same effect. Some features contain child features you specify using a dot notation. For example, landscape.natural or road.local. If you specify only the parent feature, such as road, the styles you specify for the parent apply to all its children, such as road.local and road.highway. Note that parent features may include some elements that are not included in all of their child features. The following features are available:

• all (default) selects all features.
• administrative selects all administrative areas. Styling affects only the labels of administrative areas, not the geographical borders or fill.
• administrative.country selects countries.
• administrative.land_parcel selects land parcels.
• administrative.locality selects localities.
• administrative.neighborhood selects neighborhoods.
• administrative.province selects provinces.
• landscape selects all landscapes.
• landscape.man_made selects structures built by humans.
• landscape.natural selects natural features.
• landscape.natural.landcover selects landcover features.
• landscape.natural.terrain selects terrain features.
• poi selects all points of interest.
• poi.attraction selects tourist attractions.
• poi.business selects businesses.
• poi.government selects government buildings.
• poi.medical selects emergency services, including hospitals, pharmacies, police, doctors, and others.
• poi.park selects parks.
• poi.place_of_worship selects places of worship, including churches, temples, mosques, and others.
• poi.school selects schools.
• poi.sports_complex selects sports complexes.
• road selects all roads.
• road.arterial selects arterial roads.
• road.highway selects highways.
• road.highway.controlled_access selects highways with controlled access.
• road.local selects local roads.
• transit selects all transit stations and lines.
• transit.line selects transit lines.
• transit.station selects all transit stations.
• transit.station.airport selects airports.
• transit.station.bus selects bus stops.
• transit.station.rail selects rail stations.
• water selects bodies of water.

stylers

@Option
public final List<Styler<?>> stylers

The style rules to apply to the selected map features and elements.

Style rules are applied in the order that you specify. Do not combine multiple operations into a single style operation. Instead, define each operation as a separate entry in the style array. Note: Order is important, as some operations are not commutative. Features and/or elements that are modified through style operations (usually) already have existing styles. The operations act on those existing styles, if present.

Constructor Detail

MapTypeStyleOptions

public MapTypeStyleOptions()