import * as spikeUtils from "@arcgis/core/smartMapping/renderers/support/spikeUtils.js";
const spikeUtils = await $arcgis.import("@arcgis/core/smartMapping/renderers/support/spikeUtils.js");
@arcgis/core/smartMapping/renderers/support/spikeUtils
This module provides utility functions for creating and updating spike symbols for size renderers
generated with a spike theme.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Creates a spike symbol for use in size renderers generated with a | spikeUtils | ||
Updates the properties of a spike symbol. | spikeUtils |
Method Details
-
createSpikeSymbol
MethodcreateSpikeSymbol(symbolInfo){CIMSymbol} -
Creates a spike symbol for use in size renderers generated with a
spiketheme.ParametersSpecificationsymbolInfo ObjectAn object containing properties of the symbol to create.
Specificationcolor ColorThe color of the symbol.
strokeColor ColoroptionalThe color of the symbol stroke.
baseWidth NumberoptionalThe base width of the symbol in points.
strokeWidth NumberoptionalThe stroke width of the symbol in points.
defaultHeight NumberoptionalThe default height of the symbol.
primitiveOverrides PrimitiveOverride[]optionalThe primitive overrides for the symbol.
symbolStyle StringoptionalThe style of the symbol.
Possible Values:"triangle-solid-fill-open-outline"|"triangle-solid-fill-closed-outline"|"triangle-solid-fill-open"|"triangle-solid-fill-closed"|"triangle-gradient-fill-open-outline"|"triangle-gradient-fill-closed-outline"|"triangle-gradient-fill-open"|"triangle-gradient-fill-closed"|"triangle-open-outline"|"triangle-closed-outline"
ReturnsType Description CIMSymbol Returns a spike symbol.
-
updateSpikeSymbol
MethodupdateSpikeSymbol(symbol, symbolInfo){CIMSymbol} -
Updates the properties of a spike symbol. This is typically used to update the color and size of the symbol.
ParametersSpecificationsymbol CIMSymbolThe spike symbol to update.
symbolInfo ObjectAn object containing properties of the symbol to update.
Specificationcolor ColorThe color of the symbol.
strokeColor ColoroptionalThe color of the symbol stroke.
baseWidth NumberoptionalThe base width of the symbol in points.
strokeWidth NumberoptionalThe stroke width of the symbol in points.
defaultHeight NumberoptionalThe default height of the symbol.
primitiveOverrides PrimitiveOverride[]optionalThe primitive overrides for the symbol.
symbolStyle StringoptionalThe style of the symbol.
Possible Values:"triangle-solid-fill-open-outline"|"triangle-solid-fill-closed-outline"|"triangle-solid-fill-open"|"triangle-solid-fill-closed"|"triangle-gradient-fill-open-outline"|"triangle-gradient-fill-closed-outline"|"triangle-gradient-fill-open"|"triangle-gradient-fill-closed"|"triangle-open-outline"|"triangle-closed-outline"
ReturnsType Description CIMSymbol Returns the updated spike symbol.