require(["esri/styles/type"], function(esriStylesType) { /* code goes here */ });
Description
(Added at v3.13)
This module contains a collection of themes suitable for visualizing features by their type.
Samples
Search for
samples that use this class.
Methods
Method Details
Returns available themes. See the Object Specifications table below for the returned Object[]
properties.
Parameters:
<String > basemap |
Optional |
Specify the basemap name if you only want themes applicable to a specific basemap, for example: Example: streets , gray , topo , terrain , national-geographic , oceans , osm , satellite , hybrid , dark-gray . |
Object Specifications: <Object[]
>
<String[] > basemaps |
Required |
Basemaps that this theme has schemes for. Example: ["streets","gray","topo","terrain","national-geographic","oceans","osm","satellite","hybrid","dark-gray"]. |
<String > description |
Required |
Theme description. Example: "Default theme for basic visualization of features." |
<String > label |
Required |
Display label for theme. |
<String > name |
Required |
Name of the theme. The following themes are available: default . |
Sample:
var map;
require([
"esri/map",
"esri/styles/type", "dojo/domReady!"], function(Map, esriStylesType) {
map = new Map("map", {
basemap: "topo-vector",
center: [-122.45, 37.75], // longitude, latitude
zoom: 12
});
map.on("load", function(){
themes = esriStylesType.getAvailableThemes(map.getBasemap());
console.log(JSON.stringify(themes[0]["basemaps"]));
});
});
Returns schemes matching the given parameters. See the Object Specifications table below for the returned Object
properties.
Parameters:
<Object > params |
Required |
Parameters used to determine the returned scheme type. |
Object Specifications: <params
>
<String > basemap |
Required |
Name of the basemap. Example: streets , gray , topo , terrain , national-geographic , oceans , osm , satellite , hybrid , dark-gray . |
<String > geometryType |
Required |
Geometry type of features in your dataset. Supported types: point , line , polygon . |
<String > theme |
Required |
Name of the theme. Example: default . |
<Object
>
<Object > primaryScheme |
Required |
Primary scheme is an object with properties based on the feature geometry type.
- For points:
colors , noDataColor , size , outline
outline has color and width
- For lines:
colors , noDataColor , width
- For polygons:
colors , noDataColor , outline
outline has color and width
|
<Object[] > secondarySchemes |
Required |
Secondary schemes. It is an array of objects with properties identical to the primaryScheme . |
Sample:
var map;
require([
"esri/map",
"esri/styles/type", "dojo/domReady!"
], function (Map, esriStylesType){
map = new Map("map", {
basemap: "topo-vector",
center: [-122.45, 37.75], // longitude, latitude
zoom: 12
});
map.on("load", function (){
schemes = esriStylesType.getSchemes({theme: "default", basemap: map.getBasemap(), geometryType: "point"});
console.log(JSON.stringify(schemes));
});
});