Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: SymbolStyler
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/SymbolStyler"], function(SymbolStyler) { /* code goes here */ });
Description
(Added at v3.13)
A widget that assist with applying properties to Symbols.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new SymbolStyler(params, srcNodeRef) | Creates a new SymbolStyler widget. |
CSS
esri/dijit/SymbolStyler | Download source
Properties
| Name | Type | Summary |
|---|---|---|
| activeTab | String | Read-only: Returns the name of the currently active tab. |
Methods
| Name | Return type | Summary |
|---|---|---|
| edit(symbol, options) | None | Sets the symbol to edit. |
| getStyle() | Object | Returns the current style. |
| startup() | None | Finalizes the creation of the widget. |
| storeColors() | None | Saves the recent fill and outline colors. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| style-update | Fired every time an edit is committed. |
Constructor Details
Creates a new
SymbolStyler widget.Parameters:
< |
Required | Set of parameters used to specify the SymbolStyler widget options. |
< |
Required | Reference or ID of the HTMLElement where the widget should be rendered. |
params properties: < |
Optional | Added at v. 3.15, this supersedes portalSelf and portalUrl. Portal can be either:
|
< |
Optional | Self response of Portal used as symbol provider. More information on the Portal Self response can be found here.
NOTE: Deprecated as of v. 3.15, instead use Portal. Prior to this, portalSelf superseded portalUrl. |
< |
Optional | URL to Portal used as symbol provider. Default is http://www.arcgis.com.
NOTE: Deprecated as of v. 3.15, instead use Portal. |
Sample:
require(["esri/dijit/SymbolStyler", ...
], function(SymbolStyler, ... ) {
var symbolStyler = new SymbolStyler(params, srcNodeRef);
...
});
Property Details
<String
StringRead-only: Returns the name of the currently active tab.
Method Details
Sets the symbol to edit.
Parameters:
< |
Required | Symbol to edit. |
< |
Required | Styling options. See the Object Specifications table below for the structure of the opts object. |
Object Specifications:
<
options>< |
Required | Name of the active tab, can be either shape, fill or outline. If the requested tab is not enabled the 1st available tab will be selected. |
||||||||
< |
Optional | Color ramp options.
|
||||||||
< |
Required | When true, disables the sizing controls (width for line, otherwise size). Default is false. |
||||||||
< |
Required | Required: Schemes used for color suggestions. |
Returns the current
style. See the Object Specifications table below for the structure of the returned Object.Return type:
ObjectEvent Details
[ On Style Events | Connect Style Event ]