cimConversionUtils | References | ArcGIS Maps SDK for JavaScript

import { convertToCIMSymbol } from "@arcgis/core/symbols/support/cimConversionUtils.js";

Since: ArcGIS Maps SDK for JavaScript 4.29

Provides utility functions for converting simple symbols and picture symbols to CIMSymbols.

See also

CIMSymbol
cimSymbolUtils
symbolService

Functions

Name	Return Type	Object
`convertToCIMSymbol`	`CIMSymbol`

convertToCIMSymbol

Function

Converts a given symbol to a CIMSymbol.

Signature: convertToCIMSymbol (symbol: Symbol2DUnion): CIMSymbol

Parameters

Parameter	Type	Description	Required
symbol	`Symbol2DUnion`	The symbol to convert to a CIMSymbol.

Returns: CIMSymbol
Returns a CIMSymbol representation of the given symbol.

Example

const simpleLine = new SimpleLineSymbol({
   width: 1,
   color: "black",
   style: "dash",
   cap: "round",
});
const cimLine = cimConversionUtils.convertToCIMSymbol(simpleLine);
graphic.symbol = cimLine;