cimSymbolUtils
require(["esri/symbols/support/cimSymbolUtils"], function(cimSymbolUtils) { /* code goes here */ });
esri/symbols/support/cimSymbolUtils
Provides utility functions for CIMSymbols. These methods will allow you to get and set the size, color, and rotation of a CIMsymbol.
Method Overview
Name | Return Type | Summary | Object | |
---|---|---|---|---|
Sets the color of the symbol layers of a CIMSymbol to a given value if the symbol layer is not color locked. more details | more details | cimSymbolUtils | ||
Sets the rotation value of a CIMSymbol. more details | more details | cimSymbolUtils | ||
Color | Returns the first color of the symbol layers in a CIMSymbol. more details | more details | cimSymbolUtils | |
Number | Returns the rotation value of a CIMSymbol. more details | more details | cimSymbolUtils | |
Number | Returns the size of a given CIMSymbol. more details | more details | cimSymbolUtils | |
Scales the largest layer of a CIMSymbol to a given size. more details | more details | cimSymbolUtils |
Method Details
- applyCIMSymbolColor(symbol, color)
Sets the color of the symbol layers of a CIMSymbol to a given value if the symbol layer is not color locked.
Parameters:symbol CIMSymbolThe CIMSymbol to set the color on.
color ColorThe desired color value for the symbol.
- applyCIMSymbolRotation(symbol, rotation)
Sets the rotation value of a CIMSymbol.
Parameters:symbol CIMSymbolThe CIMSymbol to set the rotation on.
rotation NumberThe desired rotation of the symbol in degrees.
- getCIMSymbolColor(symbol){Color}
Returns the first color of the symbol layers in a CIMSymbol.
Parameter:symbol CIMSymbolThe CIMSymbol from which to get the color.
Returns:Type Description Color Returns the color of the CIMSymbol.
- getCIMSymbolRotation(symbol){Number}
Returns the rotation value of a CIMSymbol.
Parameter:symbol CIMSymbolThe CIMSymbol from which to get the rotation.
Returns:Type Description Number The rotation value of the symbol in degrees.