@arcgis/core 5.0.0-next.70 → 5.0.0-next.72
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Ground.js +1 -1
- package/analysis/Dimension/types.d.ts +5 -1
- package/analysis/DistanceMeasurementAnalysis.d.ts +22 -3
- package/analysis/ElevationProfile/types.d.ts +10 -2
- package/analysis/ShadowCast/DiscreteOptions.d.ts +4 -0
- package/analysis/ShadowCast/MinDurationOptions.d.ts +7 -0
- package/analysis/ShadowCast/TotalDurationOptions.d.ts +4 -0
- package/analysis/ShadowCastAnalysis.d.ts +51 -8
- package/analysis/Slice/types.d.ts +5 -1
- package/analysis/VolumeMeasurement/types.d.ts +5 -1
- package/analysis/VolumeMeasurement/volumeMeasurementConfiguration.js +1 -1
- package/analysis/types.d.ts +39 -7
- package/applications/Components/QuantityFormatter.js +1 -1
- package/applications/Components/analysisUtils.d.ts +1 -2
- package/applications/Components/analysisUtils.js +1 -1
- package/applications/Components/imageryUtils.d.ts +2 -2
- package/applications/Components/testUtils.d.ts +2 -0
- package/applications/KnowledgeStudio/dataModelVisualization.d.ts +1 -0
- package/applications/KnowledgeStudio/generalSdkInternalAccess.d.ts +59 -13
- package/applications/KnowledgeStudio/generalSharedKgUtils.d.ts +1 -1
- package/applications/PortalApp/layerUtils.d.ts +1 -0
- package/applications/Urban/LineImagePattern3D.d.ts +2 -0
- package/applications/Urban/imagePatternUtils.d.ts +4 -0
- package/arcade.d.ts +20 -11
- package/assets/esri/core/workers/RemoteClient.js +1 -1
- package/assets/esri/core/workers/chunks/00631252e8bd4a456253.js +1 -0
- package/assets/esri/core/workers/chunks/{322085d63719da6e443c.js → 0c02b084ae30ba138c5d.js} +1 -1
- package/assets/esri/core/workers/chunks/0f2f1731543ed21db0a8.js +1 -0
- package/assets/esri/core/workers/chunks/1b201d83e9ba7d8615c0.js +1 -0
- package/assets/esri/core/workers/chunks/1b284a6f32effe28aafc.js +1 -0
- package/assets/esri/core/workers/chunks/1bd5b421152fb0f46aa5.js +37 -0
- package/assets/esri/core/workers/chunks/{2e2c47f8a80ee9234350.js → 1d8fc0239c907ff5d1e8.js} +1 -1
- package/assets/esri/core/workers/chunks/{b4f944ef6c174b20b619.js → 23545a9adc75564ecf6e.js} +1 -1
- package/assets/esri/core/workers/chunks/261b5a5db022ef580a1b.js +1 -0
- package/assets/esri/core/workers/chunks/2bd59ece927b5c1c9f80.js +1 -0
- package/assets/esri/core/workers/chunks/{37e46461da3000949a26.js → 2d8b8880e6bff4414e95.js} +1 -1
- package/assets/esri/core/workers/chunks/2fba74bae99ece15706c.js +1 -0
- package/assets/esri/core/workers/chunks/2fc64404bc42b7250086.js +1 -0
- package/assets/esri/core/workers/chunks/33cbfc34d5e2fc1a1a4f.js +1 -0
- package/assets/esri/core/workers/chunks/35887be3e4a218268d99.js +1 -0
- package/assets/esri/core/workers/chunks/3596ae4cb2bd2f3f35d9.js +1 -0
- package/assets/esri/core/workers/chunks/37814bf052ab59a5fb9e.js +1 -0
- package/assets/esri/core/workers/chunks/4e0d299054da075e5103.js +1 -0
- package/assets/esri/core/workers/chunks/50186162cd6d7c2ef0f9.js +1 -0
- package/assets/esri/core/workers/chunks/543ea1a0e7a6f1d267d1.js +1 -0
- package/assets/esri/core/workers/chunks/{dbfb00fb28b8b9f687a1.js → 5bbf20135c87a1cc8a18.js} +1 -1
- package/assets/esri/core/workers/chunks/5ed31ec0f53c1d55c4ea.js +1 -0
- package/assets/esri/core/workers/chunks/{c448540065690cac0744.js → 6087d5dc40bb62ec48c8.js} +1 -1
- package/assets/esri/core/workers/chunks/6309e8beedf5e7f2a50f.js +1 -0
- package/assets/esri/core/workers/chunks/{1a45b4b4803337f4b99f.js → 64985e9b6e2edb3ceb37.js} +38 -38
- package/assets/esri/core/workers/chunks/65475370cc4ebe2aa657.js +1 -0
- package/assets/esri/core/workers/chunks/65d9f3bc88472008443a.js +1 -0
- package/assets/esri/core/workers/chunks/6ab0f16f5c8806855c47.js +1 -0
- package/assets/esri/core/workers/chunks/7e37a3005f2ad2c0a918.js +1 -0
- package/assets/esri/core/workers/chunks/7f2496a59379e1a61ee5.js +1 -0
- package/assets/esri/core/workers/chunks/88379cd8e8e1c7ae3c7c.js +1 -0
- package/assets/esri/core/workers/chunks/{244006d4b0547d574401.js → 935a6dccb88557f98189.js} +143 -140
- package/assets/esri/core/workers/chunks/{a808be466812db51813d.js → 9382af94bf6bf1b09c8c.js} +1 -1
- package/assets/esri/core/workers/chunks/{8e83c133b201b9b61e70.js → 979bc762ccc0d3fc2467.js} +1 -1
- package/assets/esri/core/workers/chunks/9c417f4dfb19e4c4bd71.js +1 -0
- package/assets/esri/core/workers/chunks/a554ad74be03b1ed1a72.js +1 -0
- package/assets/esri/core/workers/chunks/{e6e837e43b9348050832.js → a67c86f4254807eb6a05.js} +1 -1
- package/assets/esri/core/workers/chunks/{1ec1a1997b5577619040.js → b211b53aa7616a093b90.js} +1 -1
- package/assets/esri/core/workers/chunks/{866477acdf03b8a40bc9.js → bd1d159dce4094694c93.js} +1 -1
- package/assets/esri/core/workers/chunks/c31babdb59382b6bc007.js +1 -0
- package/assets/esri/core/workers/chunks/c8182c2cbb0ead202af6.js +1 -0
- package/assets/esri/core/workers/chunks/ce218c10b209b58e04fd.js +1 -0
- package/assets/esri/core/workers/chunks/ceef586d8cc8adc4d249.js +1 -0
- package/assets/esri/core/workers/chunks/d13e8ce9270dc0662b87.js +1 -0
- package/assets/esri/core/workers/chunks/db28d00171240b4fffac.js +1 -0
- package/assets/esri/core/workers/chunks/{8d6641d0f7c93f83c414.js → db9c7182847e8f96ffe3.js} +1 -1
- package/assets/esri/core/workers/chunks/dbd382546837aa7709e2.js +1 -0
- package/assets/esri/core/workers/chunks/{6c9dac4a869742cc2718.js → e246b256347a281c13fd.js} +1 -1
- package/assets/esri/core/workers/chunks/ea6f897f21b4f30e8e99.js +1 -0
- package/assets/esri/core/workers/chunks/{a10c6dd3bb8b3602de68.js → ee175fd4ec706f7878c0.js} +1 -1
- package/assets/esri/core/workers/chunks/{e8a3ad00936f2ccaf362.js → f0a667d8d33bc51c795d.js} +1 -1
- package/assets/esri/core/workers/chunks/f65b27fc0bc2f242aac7.js +1 -0
- package/assets/esri/core/workers/chunks/{29b09db309ff75fb3e97.js → f65d26588d2d80680a26.js} +1 -1
- package/assets/esri/core/workers/chunks/f72e6c903f55ce95a6c5.js +1 -0
- package/assets/esri/core/workers/chunks/{5dd5be91038df8902dc4.js → f7dfbf24859f4ac2421b.js} +1 -1
- package/assets/esri/core/workers/chunks/f893e10d660e819cca45.js +1 -0
- package/assets/esri/core/workers/chunks/{878010ca23da0bca9405.js → fb1ed5ef2f95ab093346.js} +1 -1
- package/assets/esri/libs/lyr3d/lyr3DMain.wasm +0 -0
- package/assets/esri/libs/lyr3d/lyr3DWorker.wasm +0 -0
- package/chunks/lyr3DMain.js +1 -1
- package/config.js +1 -1
- package/core/Version.d.ts +11 -2
- package/core/accessorSupport/types.d.ts +35 -5
- package/core/quantityFormatUtils.js +1 -1
- package/core/sql/types.d.ts +226 -31
- package/core/types.d.ts +24 -4
- package/core/workers/registry.js +1 -1
- package/editing/sharedTemplates/types.d.ts +1 -0
- package/editing/types.d.ts +2 -0
- package/effects/types.d.ts +1 -0
- package/form/ExpressionInfo.d.ts +1 -1
- package/form/FormTemplate.d.ts +4 -4
- package/form/elements/GroupElement.d.ts +1 -1
- package/form/elements/RelationshipElement.d.ts +3 -3
- package/form/elements/inputs/attachments/AttachmentInput.d.ts +2 -1
- package/form/elements/inputs/attachments/AudioInput.d.ts +1 -0
- package/form/elements/inputs/attachments/DocumentInput.d.ts +1 -0
- package/form/elements/inputs/attachments/ImageInput.d.ts +1 -0
- package/form/elements/inputs/attachments/Input.d.ts +5 -1
- package/form/elements/inputs/attachments/SignatureInput.d.ts +1 -0
- package/form/elements/inputs/attachments/VideoInput.d.ts +1 -0
- package/form/elements/inputs/attachments/types.d.ts +12 -3
- package/form/elements/inputs.d.ts +2 -2
- package/form/types.d.ts +3 -0
- package/geometry/geometryEngineTypes.d.ts +49 -9
- package/geometry/operators/types.d.ts +29 -4
- package/geometry/spatialReferenceEllipsoidUtils.js +1 -1
- package/geometry/support/MeshVertexAttributes.d.ts +21 -2
- package/geometry/support/meshUtils/types.d.ts +126 -18
- package/geometry/types.d.ts +37 -6
- package/ground/NavigationConstraint.d.ts +3 -0
- package/identity/IdentityManagerBase.d.ts +153 -27
- package/interfaces.d.ts +27 -27
- package/intl/date.d.ts +5 -0
- package/intl/locale.d.ts +1 -0
- package/intl/messages.d.ts +12 -2
- package/intl/number.d.ts +5 -0
- package/intl/substitute.d.ts +28 -5
- package/intl/t9n.d.ts +13 -2
- package/kernel.js +1 -1
- package/layers/GaussianSplatLayer.d.ts +87 -6
- package/layers/ImageryTileLayer.d.ts +8 -8
- package/layers/IntegratedMesh3DTilesLayer.js +1 -1
- package/layers/LinkChartLayer.d.ts +1 -1
- package/layers/Lyr3DWasmPerSceneView.js +1 -1
- package/layers/RouteLayer.d.ts +3 -3
- package/layers/buildingSublayers/utils.d.ts +1 -0
- package/layers/effects/types.d.ts +12 -2
- package/layers/graphics/editingSupport.d.ts +202 -38
- package/layers/graphics/sources/ParquetSource.d.ts +23 -4
- package/layers/knowledgeGraph/IdTypePair.d.ts +15 -3
- package/layers/knowledgeGraph/KnowledgeGraphLayerDataManager.d.ts +61 -9
- package/layers/knowledgeGraph/LayoutMode.d.ts +1 -0
- package/layers/knowledgeGraph/dataModelVisualizationUtils.d.ts +6 -0
- package/layers/media/types.d.ts +25 -4
- package/layers/mixins/ArcGISImageService.d.ts +8 -9
- package/layers/mixins/ArcGISMapService.d.ts +5 -1
- package/layers/mixins/EditBusLayer.d.ts +3 -5
- package/layers/mixins/ImageryTileMixin.d.ts +2 -4
- package/layers/mixins/RasterJobHandlerMixin.js +1 -1
- package/layers/mixins/ScaleRange.d.ts +11 -2
- package/layers/mixins/properties/ILayerWithGetFeatureTitle.d.ts +11 -2
- package/layers/mixins/properties/ILayerWithGetField.d.ts +6 -1
- package/layers/ogc/ogcFeatureUtils.d.ts +2 -0
- package/layers/ogc/types.d.ts +55 -10
- package/layers/ogc/wcsUtils.d.ts +1 -0
- package/layers/ogc/wfsUtils.d.ts +8 -17
- package/layers/orientedImagery/core/ElevationSourceDefinitions.d.ts +6 -1
- package/layers/orientedImagery/transformations/types.d.ts +117 -21
- package/layers/orientedImagery/types.d.ts +37 -6
- package/layers/pointCloudFilters/typeUtils.d.ts +1 -0
- package/layers/raster/datasets/TIFFRaster.js +1 -1
- package/layers/raster/datasets/pixelReader.d.ts +2 -0
- package/layers/raster/datasets/types.d.ts +1 -0
- package/layers/raster/datasets/wcsCapabilitiesParser.d.ts +86 -17
- package/layers/raster/datasets/wcsCoverageParser.d.ts +601 -115
- package/layers/raster/formats/ImageCanvasDecoder.js +1 -1
- package/layers/raster/formats/JpgPlus.js +1 -1
- package/layers/raster/formats/RasterCodec.js +1 -1
- package/layers/raster/formats/Raw.js +1 -1
- package/layers/raster/formats/TiffDecoder.js +1 -1
- package/layers/raster/functions/changeDetectionUtils.d.ts +1 -0
- package/layers/raster/functions/creators/createAppearenceFunctions.d.ts +82 -15
- package/layers/raster/functions/creators/createBandIndexFunctions.d.ts +380 -70
- package/layers/raster/functions/creators/createChangeFunctions.d.ts +11 -2
- package/layers/raster/functions/creators/createConversionFunctions.d.ts +18 -3
- package/layers/raster/functions/creators/createDataManagementFunctions.d.ts +179 -35
- package/layers/raster/functions/creators/createLocalFunctions.d.ts +47 -9
- package/layers/raster/functions/creators/createMultiRasterAnalysisFunctions.d.ts +47 -9
- package/layers/raster/functions/creators/createStatisticsFunctions.d.ts +42 -8
- package/layers/raster/functions/creators/createSurfaceFunctions.d.ts +72 -11
- package/layers/raster/functions/focalStatUtils.d.ts +1 -0
- package/layers/raster/functions/rasterProjectionHelper.js +1 -1
- package/layers/raster/functions/types.d.ts +29 -5
- package/layers/raster/types.d.ts +498 -6
- package/layers/support/BuildingFilterBlock.d.ts +19 -3
- package/layers/support/BuildingFilterMode.d.ts +1 -0
- package/layers/support/BuildingFilterModeSolid.d.ts +7 -1
- package/layers/support/BuildingFilterModeWireFrame.d.ts +17 -3
- package/layers/support/BuildingFilterModeXRay.d.ts +7 -1
- package/layers/support/CodedValue.d.ts +16 -3
- package/layers/support/ControlPoint.d.ts +17 -3
- package/layers/support/EditFieldsInfo.d.ts +21 -4
- package/layers/support/EditingCapabilities.d.ts +36 -7
- package/layers/support/ElevationQuery.js +1 -1
- package/layers/support/ElevationTileData.d.ts +25 -5
- package/layers/support/FieldFormat.d.ts +1 -0
- package/layers/support/GeometryDescriptor.js +1 -1
- package/layers/support/GeoreferenceBase.d.ts +1 -0
- package/layers/support/KMLMapImage.d.ts +13 -2
- package/layers/support/LabelExpressionInfo.d.ts +9 -1
- package/layers/support/MosaicRule.d.ts +41 -1
- package/layers/support/ParquetGeometryEncodingLocation.d.ts +13 -2
- package/layers/support/ParquetGeometryEncodingWkb.d.ts +7 -0
- package/layers/support/PixelBlock.d.ts +9 -4
- package/layers/support/PurgeOptions.d.ts +15 -2
- package/layers/support/RasterInfo.d.ts +1 -2
- package/layers/support/RasterJobHandler.js +1 -1
- package/layers/support/RasterWorker.js +1 -1
- package/layers/support/SpriteSource.d.ts +28 -6
- package/layers/support/layerUtils.d.ts +4 -0
- package/layers/support/rasterFunctionConstants.d.ts +39 -0
- package/layers/support/types.d.ts +423 -227
- package/layers/types.d.ts +771 -196
- package/layers/video/types.d.ts +72 -14
- package/layers/voxel/VoxelColorStop.d.ts +17 -3
- package/layers/voxel/VoxelFormat.d.ts +15 -2
- package/layers/voxel/VoxelIsosurface.d.ts +17 -2
- package/layers/voxel/VoxelOpacityStop.d.ts +8 -1
- package/layers/voxel/VoxelRangeFilter.d.ts +12 -2
- package/layers/voxel/VoxelUniqueValue.d.ts +19 -3
- package/layers/wms/types.d.ts +104 -19
- package/layers/wmts/types.d.ts +1 -0
- package/linkChart/ChronologicalLayoutSettings.d.ts +1 -1
- package/linkChart/OrganicLayoutSettings.d.ts +1 -1
- package/linkChart/types.d.ts +2 -0
- package/networks/UtilityNetworkTraceAnalysis.d.ts +61 -10
- package/networks/support/jsonTypes.d.ts +373 -71
- package/networks/support/typeUtils.d.ts +10 -0
- package/networks/support/utils.d.ts +30 -6
- package/package.json +1 -1
- package/popup/content/types.d.ts +1 -0
- package/popup/types.d.ts +33 -5
- package/portal/jsonTypes.d.ts +231 -39
- package/portal/support/resourceUtils.d.ts +49 -9
- package/portal/types.d.ts +98 -14
- package/renderers/FlowRenderer.js +1 -1
- package/renderers/RasterStretchRenderer.d.ts +1 -1
- package/renderers/support/AuthoringInfoClassBreakInfo.d.ts +4 -0
- package/renderers/support/AuthoringInfoFieldInfo.d.ts +15 -2
- package/renderers/support/DotDensityLegendOptions.d.ts +4 -0
- package/renderers/support/HeatmapLegendOptions.d.ts +8 -0
- package/renderers/support/OthersCategory.d.ts +6 -0
- package/renderers/support/RendererLegendOptions.d.ts +14 -2
- package/renderers/support/pointCloud/ColorClassBreakInfo.d.ts +13 -1
- package/renderers/support/pointCloud/ColorModulation.d.ts +6 -0
- package/renderers/support/pointCloud/ColorUniqueValueInfo.d.ts +19 -3
- package/renderers/support/pointCloud/PointSizeAlgorithm.d.ts +1 -0
- package/renderers/support/pointCloud/PointSizeFixedSizeAlgorithm.d.ts +14 -2
- package/renderers/support/pointCloud/PointSizeSplatAlgorithm.d.ts +9 -1
- package/renderers/support/pointCloud/types.d.ts +7 -1
- package/renderers/support/raster/types.d.ts +22 -2
- package/renderers/support/types.d.ts +29 -2
- package/renderers/types.d.ts +47 -4
- package/renderers/visualVariables/support/SizeVariableLegendOptions.d.ts +4 -0
- package/renderers/visualVariables/support/VisualVariableLegendOptions.d.ts +9 -1
- package/request/types.d.ts +152 -24
- package/rest/featureService/FeatureService.d.ts +1 -1
- package/rest/featureService/types.d.ts +426 -80
- package/rest/geometryService/types.d.ts +23 -1
- package/rest/geoprocessor/GPOptions.d.ts +5 -5
- package/rest/geoprocessor/execute.d.ts +6 -0
- package/rest/imageService.d.ts +5 -5
- package/rest/knowledgeGraph/DataModel.d.ts +2 -2
- package/rest/knowledgeGraph/GraphAnyValue.d.ts +1 -0
- package/rest/knowledgeGraph/GraphDataModelSingletonOperationResult.d.ts +12 -2
- package/rest/knowledgeGraph/GraphDeleteNamedTypeResult.d.ts +1 -1
- package/rest/knowledgeGraph/GraphDeletePropertyResult.d.ts +1 -1
- package/rest/knowledgeGraph/GraphQuery.d.ts +1 -1
- package/rest/knowledgeGraph/GraphSearch.d.ts +3 -3
- package/rest/knowledgeGraph/GraphSearchStreaming.d.ts +3 -3
- package/rest/knowledgeGraph/SearchIndex.d.ts +1 -1
- package/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsPathFilter.d.ts +3 -3
- package/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsResultJSON.d.ts +151 -29
- package/rest/knowledgeGraph/toolService/findPaths/CIMKGTraversalDirection.d.ts +1 -1
- package/rest/knowledgeGraph/wasmInterface/KnowledgeWasmInterface.d.ts +1 -0
- package/rest/knowledgeGraph/wasmInterface/WasmDataModelWrapperInterfaces.d.ts +9 -0
- package/rest/knowledgeGraphService.d.ts +4 -4
- package/rest/lastMileDelivery/types.d.ts +5 -0
- package/rest/layerSources/DynamicDataLayer.d.ts +14 -2
- package/rest/layerSources/DynamicMapLayer.d.ts +14 -2
- package/rest/layerSources/JoinTableDataSource.d.ts +21 -2
- package/rest/layerSources/QueryTableDataSource.d.ts +33 -6
- package/rest/layerSources/RasterDataSource.d.ts +17 -3
- package/rest/layerSources/TableDataSource.d.ts +22 -4
- package/rest/networks/circuits/support/ExportCircuitsParameters.d.ts +8 -1
- package/rest/networks/circuits/support/QueryCircuitsParameters.d.ts +18 -3
- package/rest/networks/support/QueryNamedTraceConfigurationsParameters.d.ts +22 -4
- package/rest/print.d.ts +1 -1
- package/rest/query/support/AttachmentInfo.d.ts +1 -1
- package/rest/support/AddressToLocationsParameters.d.ts +39 -3
- package/rest/support/AddressesToLocationsParameters.d.ts +14 -0
- package/rest/support/BaseImageMeasureResultValue.d.ts +21 -4
- package/rest/support/ClosestFacilityParameters.d.ts +3 -3
- package/rest/support/ClosestFacilitySolveResult.d.ts +2 -2
- package/rest/support/DirectionsString.d.ts +16 -3
- package/rest/support/ImageMeasureResultAngleValue.d.ts +12 -2
- package/rest/support/ImageMeasureResultAreaValue.d.ts +12 -2
- package/rest/support/ImageMeasureResultLengthValue.d.ts +12 -2
- package/rest/support/LocateSetting.d.ts +12 -2
- package/rest/support/LocateSettingBase.d.ts +14 -2
- package/rest/support/LocateSettingSource.d.ts +12 -2
- package/rest/support/LocateSettings.d.ts +22 -4
- package/rest/support/LocateSettingsOverrides.d.ts +42 -8
- package/rest/support/LocationToAddressParameters.d.ts +7 -0
- package/rest/support/NetworkAttribute.d.ts +11 -2
- package/rest/support/NetworkServiceDescription.d.ts +20 -4
- package/rest/support/QuantizationParameters.d.ts +9 -0
- package/rest/support/Query.d.ts +2 -2
- package/rest/support/RouteParameters.d.ts +2 -5
- package/rest/support/RouteResult.d.ts +1 -1
- package/rest/support/ServiceAreaParameters.d.ts +1 -1
- package/rest/support/ServiceAreaSolveResult.d.ts +2 -2
- package/rest/support/SuggestLocationsParameters.d.ts +10 -0
- package/rest/support/SuggestionCandidate.d.ts +14 -2
- package/rest/support/types.d.ts +54 -4
- package/rest/symbolService.d.ts +2 -2
- package/rest/types.d.ts +50 -5
- package/rest/versionManagement/gdbVersion/support/AlterVersionParameters.d.ts +22 -4
- package/rest/versionManagement/gdbVersion/support/PostResult.d.ts +6 -1
- package/rest/versionManagement/gdbVersion/support/ReconcileParameters.d.ts +10 -1
- package/rest/versionManagement/gdbVersion/support/ReconcileResult.d.ts +8 -1
- package/rest/versionManagement/support/CreateVersionParameters.d.ts +13 -2
- package/rest/versionManagement/support/GetVersionInfosParameters.d.ts +8 -1
- package/smartMapping/heuristics/types.d.ts +50 -6
- package/smartMapping/popup/types.d.ts +29 -5
- package/smartMapping/raster/renderers/types.d.ts +12 -1
- package/smartMapping/raster/support/adapters/types.d.ts +1 -0
- package/smartMapping/renderers/color.d.ts +9 -3
- package/smartMapping/renderers/dotDensity.d.ts +3 -1
- package/smartMapping/renderers/heatmap.d.ts +3 -1
- package/smartMapping/renderers/location.d.ts +3 -1
- package/smartMapping/renderers/opacity.d.ts +3 -1
- package/smartMapping/renderers/pieChart.d.ts +3 -1
- package/smartMapping/renderers/predominance.d.ts +3 -1
- package/smartMapping/renderers/relationship.d.ts +3 -1
- package/smartMapping/renderers/size.d.ts +23 -7
- package/smartMapping/renderers/support/rendererUtils.d.ts +3 -1
- package/smartMapping/renderers/type.d.ts +3 -1
- package/smartMapping/renderers/univariateColorSize.d.ts +3 -1
- package/smartMapping/statistics/types.d.ts +16 -4
- package/smartMapping/symbology/type.d.ts +5 -1
- package/smartMapping/symbology/types.d.ts +1303 -241
- package/smartMapping/types.d.ts +5 -0
- package/statistics/types.d.ts +13 -2
- package/support/revision.js +1 -1
- package/symbols/callouts/LineCallout3DBorder.d.ts +4 -0
- package/symbols/cim/types.d.ts +764 -111
- package/symbols/patterns/LinePattern3D.d.ts +1 -0
- package/symbols/patterns/Pattern3D.d.ts +1 -0
- package/symbols/support/IconSymbol3DLayerResource.d.ts +7 -0
- package/symbols/support/ObjectSymbol3DLayerResource.d.ts +7 -0
- package/symbols/support/OccludedVisibility.d.ts +3 -0
- package/symbols/support/Symbol3DAnchorPosition2D.d.ts +4 -0
- package/symbols/support/Symbol3DAnchorPosition3D.d.ts +5 -0
- package/symbols/support/Symbol3DFillMaterial.d.ts +4 -0
- package/symbols/support/Symbol3DHalo.d.ts +10 -0
- package/symbols/support/Symbol3DIconOutline.d.ts +10 -0
- package/symbols/support/Symbol3DMaterial.d.ts +6 -0
- package/symbols/support/Symbol3DOutline.d.ts +21 -2
- package/symbols/support/Symbol3DTextBackground.d.ts +12 -2
- package/symbols/support/symbolUtils.d.ts +5 -1
- package/symbols/support/types.d.ts +4 -0
- package/symbols/types.d.ts +67 -7
- package/tables/AttributeTableTemplate.d.ts +2 -2
- package/tables/elements/AttributeTableAttachmentElement.d.ts +1 -1
- package/tables/elements/AttributeTableElement.d.ts +2 -2
- package/tables/elements/AttributeTableFieldElement.d.ts +1 -1
- package/tables/elements/AttributeTableGroupElement.d.ts +1 -1
- package/tables/elements/AttributeTableRelationshipElement.d.ts +1 -1
- package/tables/support/FieldOrder.d.ts +16 -3
- package/tables/support/tablesUtils.d.ts +1 -0
- package/time/types.d.ts +4 -0
- package/versionManagement/VersionManagementService.d.ts +3 -6
- package/versionManagement/VersionManager.d.ts +126 -23
- package/versionManagement/VersioningState.d.ts +1 -1
- package/versionManagement/support/jsonTypes.d.ts +152 -30
- package/versionManagement/support/type.d.ts +2 -0
- package/versionManagement/versionAdapters/types.d.ts +25 -5
- package/views/2d/MapViewConstraints.d.ts +37 -5
- package/views/2d/analysis/AnalysisView2D.d.ts +5 -1
- package/views/2d/analysis/AreaMeasurementAnalysisView2D.d.ts +28 -4
- package/views/2d/analysis/DistanceMeasurementAnalysisView2D.d.ts +28 -4
- package/views/2d/analysis/types.d.ts +5 -1
- package/views/2d/engine/flow/BrushFlow.js +1 -1
- package/views/2d/engine/flow/FlowDisplayObject.js +1 -1
- package/views/2d/engine/flow/FlowStrategy.js +1 -1
- package/views/2d/engine/flow/FlowView2D.js +1 -1
- package/views/2d/engine/flow/ProcessingTimeEstimate.js +5 -0
- package/views/2d/engine/flow/animatedValues.js +5 -0
- package/views/2d/engine/flow/dataUtils.js +1 -1
- package/views/2d/engine/flow/flowPathsIO.js +5 -0
- package/views/2d/engine/flow/styles/AFlowResources.js +5 -0
- package/views/2d/engine/flow/styles/Imagery.js +1 -1
- package/views/2d/engine/flow/styles/Particles.js +1 -1
- package/views/2d/engine/flow/styles/Stack.js +1 -1
- package/views/2d/engine/flow/styles/Streamlines.js +1 -1
- package/views/2d/engine/flow/utils.js +1 -1
- package/views/2d/engine/vectorTiles/shaders/sources/shaderRepository.js +1 -1
- package/views/2d/engine/webgl/shaders/sources/shaderRepository.js +1 -1
- package/views/2d/layers/support/MediaLayerInteractionOptions.d.ts +1 -0
- package/views/2d/layers/types.d.ts +1 -0
- package/views/2d/types.d.ts +93 -6
- package/views/3d/analysis/AnalysisView3D.d.ts +5 -1
- package/views/3d/analysis/AreaMeasurement/support/AreaMeasurementController.js +1 -1
- package/views/3d/analysis/AreaMeasurement/support/AreaMeasurementVisualization.js +1 -1
- package/views/3d/analysis/AreaMeasurement/support/MeasurementData.js +1 -1
- package/views/3d/analysis/AreaMeasurementAnalysisView3D.js +1 -1
- package/views/3d/analysis/DirectLineMeasurement/types.d.ts +24 -4
- package/views/3d/analysis/LineOfSight/types.d.ts +1 -0
- package/views/3d/analysis/ShadowCastAnalysisView3D.d.ts +19 -3
- package/views/3d/analysis/VolumeMeasurement/VolumeMeasurementCutFillVisualization.js +1 -1
- package/views/3d/analysis/VolumeMeasurement/types.d.ts +5 -1
- package/views/3d/analysis/support/measurementUtils.js +1 -1
- package/views/3d/analysis/types.d.ts +25 -3
- package/views/3d/constraints/AltitudeConstraint.d.ts +5 -0
- package/views/3d/constraints/ClipDistanceConstraint.d.ts +13 -2
- package/views/3d/constraints/Constraints.d.ts +26 -4
- package/views/3d/constraints/TiltConstraint.d.ts +5 -0
- package/views/3d/environment/SceneViewEnvironment.d.ts +9 -0
- package/views/3d/environment/types.d.ts +3 -0
- package/views/3d/interactive/measurementTools/areaMeasurement3D/AreaMeasurement3DView.js +1 -1
- package/views/3d/interactive/visualElements/LineVisualElement.js +1 -1
- package/views/3d/interactive/visualElements/MeasurementAreaVisualElement.js +1 -1
- package/views/3d/interactive/visualElements/support/Segment.js +1 -1
- package/views/3d/layers/ImageryLayerView3D.js +1 -1
- package/views/3d/layers/IntegratedMesh3DTilesLayerView3D.js +1 -1
- package/views/3d/layers/i3s/LayerElevationProvider.js +1 -1
- package/views/3d/layers/support/MediaLayerInteractionOptions.d.ts +15 -2
- package/views/3d/layers/support/MediaLayerInteractionReshapeOptions.d.ts +3 -0
- package/views/3d/types.d.ts +52 -0
- package/views/3d/webgl/ManagedColorAttachment.d.ts +2 -0
- package/views/3d/webgl/ManagedDepthAttachment.d.ts +2 -0
- package/views/3d/webgl/ManagedFBO.d.ts +4 -0
- package/views/3d/webgl/ManagedFBOAttachment.d.ts +1 -0
- package/views/3d/webgl/ManagedFBOResource.d.ts +5 -0
- package/views/3d/webgl/types.d.ts +32 -6
- package/views/3d/webgl-engine/core/shaderLibrary/shading/EvaluateSceneLighting.glsl.js +20 -22
- package/views/3d/webgl-engine/core/shaderLibrary/shading/Gamma.glsl.js +9 -5
- package/views/3d/webgl-engine/core/shaderLibrary/terrain/TerrainTexture.glsl.js +8 -6
- package/views/3d/webgl-engine/effects/RenderPlugin.js +1 -1
- package/views/3d/webgl-engine/effects/RenderPluginManager.js +1 -1
- package/views/3d/webgl-engine/effects/geometry/RenderOccludedRenderNode.js +1 -1
- package/views/3d/webgl-engine/lib/Material.js +1 -1
- package/views/3d/webgl-engine/lib/Renderer.js +1 -1
- package/views/3d/webgl-engine/materials/HUDMaterial.js +1 -1
- package/views/3d/webgl-engine/materials/SlicePlaneMaterial.js +1 -1
- package/views/3d/webgl-engine/materials/VisualVariablePassParameters.js +1 -1
- package/views/3d/webgl-engine/materials/renderers/MergedRenderer.js +1 -1
- package/views/3d/webgl-engine/shaders/DefaultMaterialTechnique.js +1 -1
- package/views/3d/webgl-engine/shaders/OutputColorHighlightOLID.glsl.js +9 -8
- package/views/MapViewOrSceneView.d.ts +1 -0
- package/views/SceneView.d.ts +59 -0
- package/views/SceneView.js +1 -1
- package/views/View.d.ts +2 -2
- package/views/View2D.d.ts +37 -0
- package/views/View2D.js +1 -1
- package/views/Viewport2DMixin.d.ts +9 -6
- package/views/analysis/AnalysisView.d.ts +2 -0
- package/views/analysis/AreaMeasurement/types.d.ts +18 -3
- package/views/analysis/DistanceMeasurement/types.d.ts +13 -2
- package/views/analysis/ElevationProfile/ElevationProfileLineGroundComputation.js +1 -1
- package/views/analysis/ElevationProfile/elevationProfileGenerationUtils.js +1 -1
- package/views/analysis/types.d.ts +7 -1
- package/views/animation/easing.js +1 -1
- package/views/animation/types.d.ts +3 -4
- package/views/draw/CursorUpdateEvent.d.ts +24 -4
- package/views/draw/DrawAction.d.ts +4 -6
- package/views/draw/DrawCompleteEvent.d.ts +18 -3
- package/views/draw/VertexAddEvent.d.ts +19 -3
- package/views/draw/VertexRemoveEvent.d.ts +19 -3
- package/views/draw/types.d.ts +4 -0
- package/views/input/types.d.ts +371 -57
- package/views/interactive/sketch/SketchTooltipVisibleElements.d.ts +19 -1
- package/views/interactive/sketch/Units.d.ts +5 -0
- package/views/interactive/tooltip/types.d.ts +2 -0
- package/views/layers/HighlightLayerViewMixin.d.ts +59 -1
- package/views/layers/HighlightLayerViewMixin.js +1 -1
- package/views/layers/ImageryLayerViewMixin.d.ts +60 -2
- package/views/layers/ImageryTileLayerViewMixin.d.ts +2 -0
- package/views/layers/LayerView.d.ts +6 -0
- package/views/layers/MediaLayerViewMixin.d.ts +8 -1
- package/views/layers/types.d.ts +3 -0
- package/views/navigation/types.d.ts +6 -1
- package/views/support/AttributionItem.d.ts +10 -2
- package/views/support/MeasurementWorker.js +5 -0
- package/views/support/MeasurementWorkerHandle.js +5 -0
- package/views/support/automaticAreaMeasurementUtils.js +1 -1
- package/views/support/geodesicAreaMeasurementUtils.js +1 -1
- package/views/support/geodesicLengthMeasurementUtils.js +1 -1
- package/views/types.d.ts +306 -53
- package/views/ui/types.d.ts +42 -6
- package/webdoc/Widgets.d.ts +26 -5
- package/webdoc/geotriggersInfo/support/typeUtils.d.ts +3 -0
- package/webdoc/support/SlideThumbnail.d.ts +4 -0
- package/webdoc/support/types.d.ts +11 -2
- package/webdoc/support/webdocSaveUtils.d.ts +6 -0
- package/webdoc/widgets/FloorFilter.d.ts +25 -4
- package/webmap/Version.d.ts +1 -0
- package/webscene/Version.d.ts +1 -0
- package/webscene/support/Description.d.ts +3 -0
- package/webscene/support/SlideEnvironment.d.ts +6 -0
- package/webscene/support/SlideGround.d.ts +7 -1
- package/webscene/support/SlideVisibleLayer.d.ts +5 -0
- package/webscene/support/Title.d.ts +3 -0
- package/widgets/AreaMeasurement3D/AreaMeasurement3DViewModel.js +1 -1
- package/widgets/Attachments/types.d.ts +32 -6
- package/widgets/BasemapGallery/types.d.ts +3 -0
- package/widgets/BasemapLayerList/BasemapLayerListVisibleElements.d.ts +14 -0
- package/widgets/BasemapLayerList/types.d.ts +1 -0
- package/widgets/BatchAttributeForm/VisibleElements.d.ts +7 -1
- package/widgets/BatchAttributeForm/inputs/SingleFeatureInput.d.ts +2 -0
- package/widgets/BatchAttributeForm/inputs/TextElementInput.d.ts +14 -2
- package/widgets/BatchAttributeForm/inputs/types.d.ts +2 -0
- package/widgets/BatchAttributeForm/types.d.ts +75 -14
- package/widgets/BatchAttributeForm.d.ts +2 -2
- package/widgets/Bookmarks/BookmarksVisibleElements.d.ts +30 -9
- package/widgets/Bookmarks/types.d.ts +32 -10
- package/widgets/CatalogLayerList/CatalogLayerListVisibleElements.d.ts +11 -0
- package/widgets/CatalogLayerList/types.d.ts +1 -0
- package/widgets/Daylight/VisibleElements.d.ts +11 -1
- package/widgets/Daylight/types.d.ts +8 -2
- package/widgets/DirectionalPad/VisibleElements.d.ts +6 -0
- package/widgets/DirectionalPad/types.d.ts +13 -2
- package/widgets/Directions/DirectionsViewModel.d.ts +2 -2
- package/widgets/Directions/DirectionsVisibleElements.d.ts +8 -0
- package/widgets/Editor/CreateFeaturesWorkflowData.d.ts +3 -3
- package/widgets/Editor/EditorViewModel.d.ts +2 -3
- package/widgets/Editor/Edits.d.ts +1 -2
- package/widgets/Editor/SplitFeatureWorkflow.d.ts +2 -2
- package/widgets/Editor/VisibleElements.d.ts +46 -13
- package/widgets/Editor/support/EditorEditingCapabilities.d.ts +46 -9
- package/widgets/Editor/types.d.ts +149 -24
- package/widgets/ElevationProfile/ElevationProfileVisibleElements.d.ts +13 -1
- package/widgets/ElevationProfile/types.d.ts +87 -14
- package/widgets/Expand.d.ts +2 -2
- package/widgets/Feature/types.d.ts +105 -18
- package/widgets/FeatureForm/GroupInput.d.ts +1 -1
- package/widgets/FeatureForm/RelationshipInput.d.ts +1 -1
- package/widgets/FeatureForm/TextElementInput.d.ts +3 -5
- package/widgets/FeatureForm/UtilityNetworkAssociationInput.d.ts +1 -1
- package/widgets/FeatureForm/VisibleElements.d.ts +7 -1
- package/widgets/FeatureForm/types.d.ts +3 -0
- package/widgets/FeatureForm.d.ts +1 -1
- package/widgets/FeatureTable/ColumnMenuVisibleElements.d.ts +4 -0
- package/widgets/FeatureTable/FeatureTableViewModel.d.ts +14 -4
- package/widgets/FeatureTable/Grid/Column.d.ts +1 -1
- package/widgets/FeatureTable/Grid/GridViewModel.d.ts +2 -0
- package/widgets/FeatureTable/Grid/types.d.ts +137 -24
- package/widgets/FeatureTable/TableMenuVisibleElements.d.ts +10 -0
- package/widgets/FeatureTable/VisibleElements.d.ts +16 -2
- package/widgets/FeatureTable/support/ColumnTemplateBase.d.ts +1 -1
- package/widgets/FeatureTable/support/types.d.ts +155 -27
- package/widgets/FeatureTable.d.ts +3 -3
- package/widgets/FeatureTemplates/VisibleElements.d.ts +4 -0
- package/widgets/FeatureTemplates/types.d.ts +17 -2
- package/widgets/Features/FeaturesVisibleElements.d.ts +12 -0
- package/widgets/FloorFilter/FloorFilterViewModel.js +1 -1
- package/widgets/Histogram/types.d.ts +14 -2
- package/widgets/HistogramRangeSlider/types.d.ts +1 -0
- package/widgets/LayerList/LayerListVisibleElements.d.ts +10 -0
- package/widgets/LayerList/types.d.ts +8 -0
- package/widgets/Legend/styles/card/CardView.d.ts +13 -2
- package/widgets/Legend/styles/classic/ClassicView.d.ts +11 -2
- package/widgets/Measurement/types.d.ts +3 -0
- package/widgets/OrientedImageryViewer/types.d.ts +15 -3
- package/widgets/Popup/PopupVisibleElements.d.ts +11 -0
- package/widgets/Popup/types.d.ts +64 -7
- package/widgets/Print/FileLink.d.ts +36 -6
- package/widgets/Print/types.d.ts +77 -13
- package/widgets/ScaleRangeSlider/types.d.ts +4 -0
- package/widgets/ScaleRangeSlider.d.ts +5 -1
- package/widgets/Search/SearchResultRenderer.d.ts +0 -2
- package/widgets/Search/SearchSource.d.ts +2 -2
- package/widgets/Search/SearchViewModel.d.ts +6 -7
- package/widgets/Search/types.d.ts +4 -4
- package/widgets/ShadowCast/ShadowCastVisibleElements.d.ts +15 -1
- package/widgets/ShadowCast/types.d.ts +8 -2
- package/widgets/Sketch/CreateToolVisibilityMap.d.ts +19 -4
- package/widgets/Sketch/SelectionToolVisibilityMap.d.ts +4 -0
- package/widgets/Sketch/VisibleElements.d.ts +38 -6
- package/widgets/Sketch/types.d.ts +364 -60
- package/widgets/Slider/types.d.ts +249 -46
- package/widgets/Swipe/types.d.ts +6 -0
- package/widgets/TableList/TableListVisibleElements.d.ts +11 -0
- package/widgets/TableList/types.d.ts +5 -0
- package/widgets/TimeSlider/types.d.ts +45 -7
- package/widgets/Track/types.d.ts +4 -1
- package/widgets/UtilityNetworkAssociations/VisibleElements.d.ts +23 -4
- package/widgets/UtilityNetworkAssociations/VisibleElementsSettingsPane.d.ts +7 -0
- package/widgets/UtilityNetworkTrace/types.d.ts +26 -5
- package/widgets/ValuePicker/ValuePickerBaseComponent.d.ts +2 -0
- package/widgets/ValuePicker/ValuePickerSliderVisibleElements.d.ts +7 -1
- package/widgets/ValuePicker/ValuePickerVisibleElements.d.ts +9 -1
- package/widgets/ValuePicker/types.d.ts +8 -0
- package/widgets/Weather/VisibleElements.d.ts +6 -1
- package/widgets/Weather/types.d.ts +1 -0
- package/widgets/smartMapping/types.d.ts +63 -6
- package/widgets/support/GridControls/VisibleElements.d.ts +11 -0
- package/widgets/support/GridControls/types.d.ts +1 -0
- package/widgets/support/SnappingControls/VisibleElements.d.ts +26 -4
- package/widgets/support/forms/types.d.ts +2 -0
- package/widgets/support/types.d.ts +19 -3
- package/widgets/types.d.ts +549 -89
- package/assets/esri/core/workers/chunks/0367a8580fede8f804f9.js +0 -1
- package/assets/esri/core/workers/chunks/14f4f5b7549cea7b5a6a.js +0 -1
- package/assets/esri/core/workers/chunks/1b475593c80d7bccdda5.js +0 -1
- package/assets/esri/core/workers/chunks/27ec8688f72130239b98.js +0 -1
- package/assets/esri/core/workers/chunks/2dd347aa2a061d536e69.js +0 -1
- package/assets/esri/core/workers/chunks/2f6fa33692478e99d24b.js +0 -1
- package/assets/esri/core/workers/chunks/329b10897c6965948b84.js +0 -1
- package/assets/esri/core/workers/chunks/35593a9790818b689455.js +0 -1
- package/assets/esri/core/workers/chunks/3e7ea06b342e33bc48a5.js +0 -1
- package/assets/esri/core/workers/chunks/401ce5cb98fa14c1a725.js +0 -1
- package/assets/esri/core/workers/chunks/4387aaf9d5e8f6d1833d.js +0 -1
- package/assets/esri/core/workers/chunks/668a868fe2dcb6384ac9.js +0 -1
- package/assets/esri/core/workers/chunks/6acfa51b81e6f4255118.js +0 -1
- package/assets/esri/core/workers/chunks/6f8098f9fe233833245a.js +0 -1
- package/assets/esri/core/workers/chunks/76dbaef0d0794913f36f.js +0 -1
- package/assets/esri/core/workers/chunks/7c5218eae13d3bd30598.js +0 -1
- package/assets/esri/core/workers/chunks/7fc09382f934e9223a9b.js +0 -1
- package/assets/esri/core/workers/chunks/822ef6a043c7e147b4b6.js +0 -1
- package/assets/esri/core/workers/chunks/980313a6c35e79812d17.js +0 -1
- package/assets/esri/core/workers/chunks/98d68b145226e7527c84.js +0 -33
- package/assets/esri/core/workers/chunks/9c157c0eeadb824ad01e.js +0 -1
- package/assets/esri/core/workers/chunks/a39ac9127a215d14d412.js +0 -1
- package/assets/esri/core/workers/chunks/a893f8db2477cf677ac8.js +0 -1
- package/assets/esri/core/workers/chunks/a95e28ade258b144cbb5.js +0 -1
- package/assets/esri/core/workers/chunks/abcee7cfd53cfe1d91e9.js +0 -1
- package/assets/esri/core/workers/chunks/b9f0d313f59fc7c43560.js +0 -1
- package/assets/esri/core/workers/chunks/bbe2eaef7edfa33b6eea.js +0 -1
- package/assets/esri/core/workers/chunks/bfdf646d4c8f175a4236.js +0 -1
- package/assets/esri/core/workers/chunks/d749aa62ad694147aebe.js +0 -1
- package/assets/esri/core/workers/chunks/d7d9656b990ce8be2152.js +0 -1
- package/assets/esri/core/workers/chunks/df92239eefff04471a0b.js +0 -1
- package/assets/esri/core/workers/chunks/ee2ca25048a920e43743.js +0 -1
- package/assets/esri/core/workers/chunks/eeb24a4ab4993f1f4e8e.js +0 -1
- package/assets/esri/core/workers/chunks/fe5d2735f057c7789f4b.js +0 -1
- package/views/2d/engine/flow/FlowDisplayData.js +0 -5
- package/views/support/GeodesicMeasurementWorker.js +0 -5
- package/views/support/GeodesicMeasurementWorkerHandle.js +0 -5
package/symbols/cim/types.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { Extent, Point } from "../../portal/jsonTypes.js";
|
|
2
2
|
|
|
3
|
+
/** @since 5.0 */
|
|
3
4
|
export type CIMColor = [
|
|
4
5
|
number,
|
|
5
6
|
number,
|
|
@@ -50,22 +51,38 @@ export type CIMColor = [
|
|
|
50
51
|
* }
|
|
51
52
|
* ```
|
|
52
53
|
*
|
|
54
|
+
* @since 5.0
|
|
53
55
|
* @see {@link symbols/cim/CIMTypes!CIMSymbolReference CIMSymbolReference.primitiveOverrides}
|
|
54
56
|
* @see [Sample - CIMSymbol (PrimitiveOverride on TextString)](https://developers.arcgis.com/javascript/latest/sample-code/cim-symbols/)
|
|
55
57
|
* @see [Sample - Symbol animations](https://developers.arcgis.com/javascript/latest/sample-code/cim-animations/)
|
|
56
58
|
*/
|
|
57
59
|
export interface CIMPrimitiveOverride {
|
|
58
|
-
/**
|
|
60
|
+
/**
|
|
61
|
+
* The primitive name this override applies to.
|
|
62
|
+
*
|
|
63
|
+
* @since 5.0
|
|
64
|
+
*/
|
|
59
65
|
primitiveName: string;
|
|
60
|
-
/**
|
|
66
|
+
/**
|
|
67
|
+
* The name of the property in the primitive this override applies to (e.g. "Size"). This value must be in Proper case (e.g. "Size" not "size").
|
|
68
|
+
*
|
|
69
|
+
* @since 5.0
|
|
70
|
+
*/
|
|
61
71
|
propertyName: string;
|
|
72
|
+
/** @since 5.0 */
|
|
62
73
|
type?: "CIMPrimitiveOverride";
|
|
63
|
-
/**
|
|
74
|
+
/**
|
|
75
|
+
* Contains the Arcade expression that returns a value to be applied to the property on the primitive.
|
|
76
|
+
*
|
|
77
|
+
* @since 5.0
|
|
78
|
+
*/
|
|
64
79
|
valueExpressionInfo?: CIMExpressionInfo;
|
|
65
80
|
}
|
|
66
81
|
|
|
82
|
+
/** @since 5.0 */
|
|
67
83
|
export interface CIMColorSpace {}
|
|
68
84
|
|
|
85
|
+
/** @since 5.0 */
|
|
69
86
|
export interface CIMColorRamp {}
|
|
70
87
|
|
|
71
88
|
/**
|
|
@@ -87,15 +104,29 @@ export interface CIMColorRamp {}
|
|
|
87
104
|
* @since 4.32
|
|
88
105
|
*/
|
|
89
106
|
export interface CIMFixedColorRamp extends CIMColorRamp {
|
|
90
|
-
/**
|
|
107
|
+
/**
|
|
108
|
+
* The ordered list of colors in the color scheme, with each color represented as an array of rbga values (`[255,255,255,255]`). The colors are applied in the order they are defined.
|
|
109
|
+
*
|
|
110
|
+
* @since 5.0
|
|
111
|
+
*/
|
|
91
112
|
colors: CIMColor[];
|
|
113
|
+
/** @since 5.0 */
|
|
92
114
|
type: "CIMFixedColorRamp";
|
|
93
115
|
}
|
|
94
116
|
|
|
117
|
+
/** @since 5.0 */
|
|
95
118
|
export interface CIMContinuousColorRamp extends CIMColorRamp {
|
|
96
|
-
/**
|
|
119
|
+
/**
|
|
120
|
+
* The color at the start of the ramp. The color is defined as an array of RGBA values (`[255,255,255,255]`).
|
|
121
|
+
*
|
|
122
|
+
* @since 5.0
|
|
123
|
+
*/
|
|
97
124
|
fromColor: CIMColor;
|
|
98
|
-
/**
|
|
125
|
+
/**
|
|
126
|
+
* The color at the end of the ramp. The color is defined as an array of RGBA values (`[255,255,255,255]`).
|
|
127
|
+
*
|
|
128
|
+
* @since 5.0
|
|
129
|
+
*/
|
|
99
130
|
toColor: CIMColor;
|
|
100
131
|
}
|
|
101
132
|
|
|
@@ -119,6 +150,7 @@ export interface CIMContinuousColorRamp extends CIMColorRamp {
|
|
|
119
150
|
* @since 4.32
|
|
120
151
|
*/
|
|
121
152
|
export interface CIMLinearContinuousColorRamp extends CIMContinuousColorRamp {
|
|
153
|
+
/** @since 5.0 */
|
|
122
154
|
type: "CIMLinearContinuousColorRamp";
|
|
123
155
|
}
|
|
124
156
|
|
|
@@ -147,10 +179,19 @@ export interface CIMLinearContinuousColorRamp extends CIMContinuousColorRamp {
|
|
|
147
179
|
* @since 4.32
|
|
148
180
|
*/
|
|
149
181
|
export interface CIMMultipartColorRamp extends CIMColorRamp {
|
|
150
|
-
/**
|
|
182
|
+
/**
|
|
183
|
+
* An ordered list of color ramps that are combined to build the multipart color ramp. Typically these are continuous color ramps.
|
|
184
|
+
*
|
|
185
|
+
* @since 5.0
|
|
186
|
+
*/
|
|
151
187
|
colorRamps: CIMColorRampUnion[];
|
|
188
|
+
/** @since 5.0 */
|
|
152
189
|
type: "CIMMultipartColorRamp";
|
|
153
|
-
/**
|
|
190
|
+
/**
|
|
191
|
+
* The proportional weight for each color ramp that make up the multipart ramp. This allows for ramp to ramp transition at specific weight points. The number of weights must match the number of color ramps.
|
|
192
|
+
*
|
|
193
|
+
* @since 5.0
|
|
194
|
+
*/
|
|
154
195
|
weights: number[];
|
|
155
196
|
}
|
|
156
197
|
|
|
@@ -163,8 +204,10 @@ export interface CIMMultipartColorRamp extends CIMColorRamp {
|
|
|
163
204
|
*/
|
|
164
205
|
export type CIMColorRampUnion = CIMLinearContinuousColorRamp | CIMFixedColorRamp | CIMMultipartColorRamp;
|
|
165
206
|
|
|
207
|
+
/** @since 5.0 */
|
|
166
208
|
export interface CIMCallout {}
|
|
167
209
|
|
|
210
|
+
/** @since 5.0 */
|
|
168
211
|
export interface CIMLineCallout extends CIMCallout {}
|
|
169
212
|
|
|
170
213
|
/**
|
|
@@ -177,17 +220,25 @@ export interface CIMBackgroundCallout extends CIMLineCallout {
|
|
|
177
220
|
/**
|
|
178
221
|
* The symbol used to draw the background.
|
|
179
222
|
* Currently, only CIMSolidStroke and CIMSolidFill symbol layers without geometric effects are supported within this symbol.
|
|
223
|
+
*
|
|
224
|
+
* @since 5.0
|
|
180
225
|
*/
|
|
181
226
|
backgroundSymbol: CIMPolygonSymbol;
|
|
182
|
-
/**
|
|
227
|
+
/**
|
|
228
|
+
* The callout type.
|
|
229
|
+
*
|
|
230
|
+
* @since 5.0
|
|
231
|
+
*/
|
|
183
232
|
type: "CIMBackgroundCallout";
|
|
184
233
|
}
|
|
185
234
|
|
|
235
|
+
/** @since 5.0 */
|
|
186
236
|
export type CIMGeometricEffects = CIMGeometricEffect[];
|
|
187
237
|
|
|
188
238
|
/**
|
|
189
239
|
* Represents a geometric effect.
|
|
190
240
|
*
|
|
241
|
+
* @since 5.0
|
|
191
242
|
* @see {@link symbols/cim/CIMTypes!CIMPointSymbol CIMPointSymbol.effects}
|
|
192
243
|
* @see {@link symbols/cim/CIMTypes!CIMLineSymbol CIMLineSymbol.effects}
|
|
193
244
|
* @see {@link symbols/cim/CIMTypes!CIMPolygonSymbol CIMPolygonSymbol.effects}
|
|
@@ -203,67 +254,105 @@ export type CIMGeometricEffects = CIMGeometricEffect[];
|
|
|
203
254
|
*/
|
|
204
255
|
export type CIMGeometricEffect = CIMGeometricEffectAddControlPoints | CIMGeometricEffectAddControlPoints | CIMGeometricEffectArrow | CIMGeometricEffectBuffer | CIMGeometricEffectControlMeasureLine | CIMGeometricEffectCut | CIMGeometricEffectDashes | CIMGeometricEffectDonut | CIMGeometricEffectEnclosingPolygon | CIMGeometricEffectJog | CIMGeometricEffectMove | CIMGeometricEffectOffset | CIMGeometricEffectRadial | CIMGeometricEffectRotate | CIMGeometricEffectScale | CIMGeometricEffectSuppress | CIMGeometricEffectTaperedPolygon | CIMGeometricEffectWave;
|
|
205
256
|
|
|
257
|
+
/** @since 5.0 */
|
|
206
258
|
export interface CIMSymbolLayer {
|
|
207
|
-
/**
|
|
259
|
+
/**
|
|
260
|
+
* The animations applied to the marker.
|
|
261
|
+
*
|
|
262
|
+
* @since 4.31
|
|
263
|
+
* @since 5.0
|
|
264
|
+
*/
|
|
208
265
|
animations?: CIMSymbolAnimation[];
|
|
209
266
|
/**
|
|
210
267
|
* A value indicating whether the color can be changed for this symbol layer. If the symbol layer is colorLocked, then any changes to the symbol's color property will not be applied to this symbol layer.
|
|
211
268
|
*
|
|
212
269
|
* @default false
|
|
270
|
+
* @since 5.0
|
|
213
271
|
*/
|
|
214
272
|
colorLocked?: boolean;
|
|
215
|
-
/**
|
|
273
|
+
/**
|
|
274
|
+
* The geometric effects applied to the symbol layer. Effects dynamically alter the geometry when the symbology is applied. Multiple effects applied to a symbol layer are rendered sequentially.
|
|
275
|
+
*
|
|
276
|
+
* @since 5.0
|
|
277
|
+
*/
|
|
216
278
|
effects?: CIMGeometricEffects;
|
|
217
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* A value indicating whether the symbol layer is visible. The symbol layer draws only when enabled.
|
|
281
|
+
*
|
|
282
|
+
* @since 5.0
|
|
283
|
+
*/
|
|
218
284
|
enable?: boolean;
|
|
219
|
-
/**
|
|
285
|
+
/**
|
|
286
|
+
* The primitive name of the symbol. Used when setting a {@link symbols/cim/CIMTypes!PrimitiveOverride}.
|
|
287
|
+
*
|
|
288
|
+
* @since 5.0
|
|
289
|
+
*/
|
|
220
290
|
primitiveName?: string;
|
|
221
291
|
}
|
|
222
292
|
|
|
223
293
|
/**
|
|
224
294
|
* Represents a marker placement.
|
|
225
295
|
*
|
|
296
|
+
* @since 5.0
|
|
226
297
|
* @see {@link symbols/cim/CIMTypes!CIMVectorMarker CIMVectorMarker.markerPlacement}
|
|
227
298
|
* @see {@link symbols/cim/CIMTypes!CIMPictureMarker CIMPictureMarker.markerPlacement}
|
|
228
299
|
*/
|
|
229
300
|
export type CIMMarkerPlacement = CIMMarkerPlacementAlongLineSameSize | CIMMarkerPlacementAtExtremities | CIMMarkerPlacementAtRatioPositions | CIMMarkerPlacementInsidePolygon | CIMMarkerPlacementOnLine | CIMMarkerPlacementOnVertices | CIMMarkerPlacementPolygonCenter;
|
|
230
301
|
|
|
302
|
+
/** @since 5.0 */
|
|
231
303
|
export interface CIMMarker extends CIMSymbolLayer {
|
|
232
|
-
/**
|
|
304
|
+
/**
|
|
305
|
+
* The specified location where all transformation property operations originate.
|
|
306
|
+
*
|
|
307
|
+
* @since 5.0
|
|
308
|
+
*/
|
|
233
309
|
anchorPoint?: Point | null;
|
|
234
310
|
/**
|
|
235
311
|
* A value which specifies if the anchor point location is considered a percentage of the size or as an absolute distance.
|
|
236
312
|
*
|
|
237
313
|
* @default "Relative"
|
|
314
|
+
* @since 5.0
|
|
238
315
|
*/
|
|
239
316
|
anchorPointUnits?: CIMSymbolUnits;
|
|
240
|
-
/**
|
|
317
|
+
/**
|
|
318
|
+
* Determines how markers are placed along a line or within a polygon.
|
|
319
|
+
*
|
|
320
|
+
* @since 5.0
|
|
321
|
+
*/
|
|
241
322
|
markerPlacement?: CIMMarkerPlacement | null;
|
|
242
323
|
/**
|
|
243
324
|
* The distance that the image is offset in the horizontal direction in points.
|
|
244
325
|
*
|
|
245
326
|
* @default 0
|
|
327
|
+
* @since 5.0
|
|
246
328
|
*/
|
|
247
329
|
offsetX?: number;
|
|
248
330
|
/**
|
|
249
331
|
* The distance that the image is offset in the vertical direction in points.
|
|
250
332
|
*
|
|
251
333
|
* @default 0
|
|
334
|
+
* @since 5.0
|
|
252
335
|
*/
|
|
253
336
|
offsetY?: number;
|
|
254
337
|
/**
|
|
255
338
|
* A value indicating whether the rotation is applied clockwise or counterclockwise to the marker layer.
|
|
256
339
|
*
|
|
257
340
|
* @default false
|
|
341
|
+
* @since 5.0
|
|
258
342
|
*/
|
|
259
343
|
rotateClockwise?: boolean;
|
|
260
344
|
/**
|
|
261
345
|
* The angle of the image within the fill.
|
|
262
346
|
*
|
|
263
347
|
* @default 0
|
|
348
|
+
* @since 5.0
|
|
264
349
|
*/
|
|
265
350
|
rotation?: number;
|
|
266
|
-
/**
|
|
351
|
+
/**
|
|
352
|
+
* The height of the marker in points. Modifying size changes the marker's height to the specified size. The width will be updated proportionally.
|
|
353
|
+
*
|
|
354
|
+
* @since 5.0
|
|
355
|
+
*/
|
|
267
356
|
size: number;
|
|
268
357
|
}
|
|
269
358
|
|
|
@@ -280,19 +369,33 @@ export interface CIMMarker extends CIMSymbolLayer {
|
|
|
280
369
|
* ]
|
|
281
370
|
* ```
|
|
282
371
|
*
|
|
372
|
+
* @since 5.0
|
|
283
373
|
* @see {@link symbols/cim/CIMTypes!CIMPictureFill CIMPictureFill.colorSubstitutions}
|
|
284
374
|
* @see {@link symbols/cim/CIMTypes!CIMPictureMarker CIMPictureMarker.colorSubstitutions}
|
|
285
375
|
* @see {@link symbols/cim/CIMTypes!CIMPictureStroke CIMPictureStroke.colorSubstitutions}
|
|
286
376
|
*/
|
|
287
377
|
export interface CIMColorSubstitution {
|
|
288
|
-
/**
|
|
378
|
+
/**
|
|
379
|
+
* The new color that will replace the old color. Value should be an array of r,b,g,a values (i.e. `[255,255,255,255]`).
|
|
380
|
+
*
|
|
381
|
+
* @since 5.0
|
|
382
|
+
*/
|
|
289
383
|
newColor: CIMColor;
|
|
290
|
-
/**
|
|
384
|
+
/**
|
|
385
|
+
* The old color (the color that will be substituted). Value should be an array of r,b,g,a values (i.e. `[255,255,255,255]`).
|
|
386
|
+
*
|
|
387
|
+
* @since 5.0
|
|
388
|
+
*/
|
|
291
389
|
oldColor: CIMColor;
|
|
292
390
|
}
|
|
293
391
|
|
|
392
|
+
/** @since 5.0 */
|
|
294
393
|
export interface CIMGeometricEffectBase {
|
|
295
|
-
/**
|
|
394
|
+
/**
|
|
395
|
+
* The primitive name.
|
|
396
|
+
*
|
|
397
|
+
* @since 5.0
|
|
398
|
+
*/
|
|
296
399
|
primitiveName: string;
|
|
297
400
|
}
|
|
298
401
|
|
|
@@ -316,8 +419,10 @@ export interface CIMGeometricEffectAddControlPoints extends CIMGeometricEffectBa
|
|
|
316
419
|
* The value below which a control point will be placed. The maximum amount of deflection from one segment to another at a vertex. Angle values between 180 and 360 are interpreted the same as values between 0 and 180. Angle values of 180 and 360 are the same as 0.
|
|
317
420
|
*
|
|
318
421
|
* @default 120
|
|
422
|
+
* @since 5.0
|
|
319
423
|
*/
|
|
320
424
|
angleTolerance: number;
|
|
425
|
+
/** @since 5.0 */
|
|
321
426
|
type: "CIMGeometricEffectAddControlPoints";
|
|
322
427
|
}
|
|
323
428
|
|
|
@@ -340,10 +445,19 @@ export interface CIMGeometricEffectAddControlPoints extends CIMGeometricEffectBa
|
|
|
340
445
|
* @see {@link symbols/cim/CIMTypes!CIMGeometricEffect}
|
|
341
446
|
*/
|
|
342
447
|
export interface CIMGeometricEffectArrow extends CIMGeometricEffectBase {
|
|
343
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* The type of arrow to be displayed.
|
|
450
|
+
*
|
|
451
|
+
* @since 5.0
|
|
452
|
+
*/
|
|
344
453
|
geometricEffectArrowType: CIMGeometricEffectArrowType;
|
|
454
|
+
/** @since 5.0 */
|
|
345
455
|
type: "CIMGeometricEffectArrow";
|
|
346
|
-
/**
|
|
456
|
+
/**
|
|
457
|
+
* The distance between the lines that construct the body of the arrow.
|
|
458
|
+
*
|
|
459
|
+
* @since 5.0
|
|
460
|
+
*/
|
|
347
461
|
width: number;
|
|
348
462
|
}
|
|
349
463
|
|
|
@@ -364,8 +478,13 @@ export interface CIMGeometricEffectArrow extends CIMGeometricEffectBase {
|
|
|
364
478
|
* @see {@link symbols/cim/CIMTypes!CIMGeometricEffect}
|
|
365
479
|
*/
|
|
366
480
|
export interface CIMGeometricEffectBuffer extends CIMGeometricEffectBase {
|
|
367
|
-
/**
|
|
481
|
+
/**
|
|
482
|
+
* The distance from the feature in points. This distance is either from the edge of the marker, the edge of the stroke or the edge of the polygon outline.
|
|
483
|
+
*
|
|
484
|
+
* @since 5.0
|
|
485
|
+
*/
|
|
368
486
|
size: number;
|
|
487
|
+
/** @since 5.0 */
|
|
369
488
|
type: "CIMGeometricEffectBuffer";
|
|
370
489
|
}
|
|
371
490
|
|
|
@@ -376,8 +495,13 @@ export interface CIMGeometricEffectBuffer extends CIMGeometricEffectBase {
|
|
|
376
495
|
* @see {@link symbols/cim/CIMTypes!CIMGeometricEffect}
|
|
377
496
|
*/
|
|
378
497
|
export interface CIMGeometricEffectControlMeasureLine extends CIMGeometricEffectBase {
|
|
379
|
-
/**
|
|
498
|
+
/**
|
|
499
|
+
* The style of effect. Must be a value from the list of [GeometricEffectControlMeasureLineRule](https://github.com/Esri/cim-spec/blob/master/docs/v2/CIMSymbols.md#enumeration-geometriceffectcontrolmeasurelinerule).
|
|
500
|
+
*
|
|
501
|
+
* @since 5.0
|
|
502
|
+
*/
|
|
380
503
|
rule: CIMGeometricEffectControlMeasureLineRule;
|
|
504
|
+
/** @since 5.0 */
|
|
381
505
|
type: "CIMGeometricEffectControlMeasureLine";
|
|
382
506
|
}
|
|
383
507
|
|
|
@@ -405,26 +529,31 @@ export interface CIMGeometricEffectCut extends CIMGeometricEffectBase {
|
|
|
405
529
|
* The distance from the beginning of a line that the display of the stroke starts. The beginning of the line is determined by the direction in which the line was digitized.
|
|
406
530
|
*
|
|
407
531
|
* @default 1
|
|
532
|
+
* @since 5.0
|
|
408
533
|
*/
|
|
409
534
|
beginCut: number;
|
|
410
535
|
/**
|
|
411
536
|
* The distance from the end of a line that the display of the stroke ends. The end of the line is determined by the direction in which the line was digitized.
|
|
412
537
|
*
|
|
413
538
|
* @default 1
|
|
539
|
+
* @since 5.0
|
|
414
540
|
*/
|
|
415
541
|
endCut: number;
|
|
416
542
|
/**
|
|
417
543
|
* A value indicating whether the effect should be applied in the opposite manner. This displays the stroke symbol only at the ends of the line and leaves the rest of the line unsymbolized.
|
|
418
544
|
*
|
|
419
545
|
* @default false
|
|
546
|
+
* @since 5.0
|
|
420
547
|
*/
|
|
421
548
|
invert: boolean;
|
|
422
549
|
/**
|
|
423
550
|
* The distance around the middle of a line that the display of the stroke is interrupted.
|
|
424
551
|
*
|
|
425
552
|
* @default 0
|
|
553
|
+
* @since 5.0
|
|
426
554
|
*/
|
|
427
555
|
middleCut: number;
|
|
556
|
+
/** @since 5.0 */
|
|
428
557
|
type: "CIMGeometricEffectCut";
|
|
429
558
|
}
|
|
430
559
|
|
|
@@ -452,22 +581,30 @@ export interface CIMGeometricEffectDashes extends CIMGeometricEffectBase {
|
|
|
452
581
|
* Where the pattern should end relative to the ending point of the geometry. Negative numbers indicate a shift to the left and positive numbers a shift to the right. This property is only applied if the `lineDashEnding` is set to `"Custom"`.
|
|
453
582
|
*
|
|
454
583
|
* @default 0
|
|
584
|
+
* @since 5.0
|
|
455
585
|
*/
|
|
456
586
|
customEndingOffset: number;
|
|
457
|
-
/**
|
|
587
|
+
/**
|
|
588
|
+
* The distance for each dash and gap. There can be multiple dash and gap values to form a complex pattern (i.e. [2,5] where 2 is the length of the dash and 5 is the length of the gap).
|
|
589
|
+
*
|
|
590
|
+
* @since 5.0
|
|
591
|
+
*/
|
|
458
592
|
dashTemplate: number[] | string;
|
|
459
593
|
/**
|
|
460
594
|
* The setting which determines how the strokes with dash patterns are handled at the end points of the line geometry's segments.
|
|
461
595
|
*
|
|
462
596
|
* @default "NoConstraint"
|
|
597
|
+
* @since 5.0
|
|
463
598
|
*/
|
|
464
599
|
lineDashEnding: CIMLineDashEnding;
|
|
465
600
|
/**
|
|
466
601
|
* The position where the pattern should begin relative to the starting point of the geometry. It shifts the entire pattern along the line the specified distance. Negative values indicate a shift to the left and positive numbers a shift to the right. This property is only applied if `lineDashEnding` is set to `NoConstraint` or `Custom`.
|
|
467
602
|
*
|
|
468
603
|
* @default 0
|
|
604
|
+
* @since 5.0
|
|
469
605
|
*/
|
|
470
606
|
offsetAlongLine?: number | null;
|
|
607
|
+
/** @since 5.0 */
|
|
471
608
|
type: "CIMGeometricEffectDashes";
|
|
472
609
|
}
|
|
473
610
|
|
|
@@ -482,10 +619,16 @@ export interface CIMGeometricEffectDonut extends CIMGeometricEffectBase {
|
|
|
482
619
|
* The option for the way the symbol handles complex geometries.
|
|
483
620
|
*
|
|
484
621
|
* @default "Accurate"
|
|
622
|
+
* @since 5.0
|
|
485
623
|
*/
|
|
486
624
|
option: CIMGeometricEffectOffsetOption;
|
|
625
|
+
/** @since 5.0 */
|
|
487
626
|
type: "CIMGeometricEffectDonut";
|
|
488
|
-
/**
|
|
627
|
+
/**
|
|
628
|
+
* The distance from the edge of the polygon that the fill symbol is to be displayed.
|
|
629
|
+
*
|
|
630
|
+
* @since 5.0
|
|
631
|
+
*/
|
|
489
632
|
width: number;
|
|
490
633
|
}
|
|
491
634
|
|
|
@@ -503,8 +646,13 @@ export interface CIMGeometricEffectDonut extends CIMGeometricEffectBase {
|
|
|
503
646
|
* @see {@link symbols/cim/CIMTypes!CIMGeometricEffect}
|
|
504
647
|
*/
|
|
505
648
|
export interface CIMGeometricEffectEnclosingPolygon extends CIMGeometricEffectBase {
|
|
506
|
-
/**
|
|
649
|
+
/**
|
|
650
|
+
* The method which speccifies the way in which the polygon geometry is generated around the feature geometry.
|
|
651
|
+
*
|
|
652
|
+
* @since 5.0
|
|
653
|
+
*/
|
|
507
654
|
method: CIMGeometricEffectEnclosingPolygonMethod;
|
|
655
|
+
/** @since 5.0 */
|
|
508
656
|
type: "CIMGeometricEffectEnclosingPolygon";
|
|
509
657
|
}
|
|
510
658
|
|
|
@@ -528,12 +676,25 @@ export interface CIMGeometricEffectEnclosingPolygon extends CIMGeometricEffectBa
|
|
|
528
676
|
* @see {@link symbols/cim/CIMTypes!CIMGeometricEffect}
|
|
529
677
|
*/
|
|
530
678
|
export interface CIMGeometricEffectJog extends CIMGeometricEffectBase {
|
|
531
|
-
/**
|
|
679
|
+
/**
|
|
680
|
+
* The angle of the job in the line which is measured in degrees.
|
|
681
|
+
*
|
|
682
|
+
* @since 5.0
|
|
683
|
+
*/
|
|
532
684
|
angle: number;
|
|
533
|
-
/**
|
|
685
|
+
/**
|
|
686
|
+
* The length of the segment that forms the jog in the line.
|
|
687
|
+
*
|
|
688
|
+
* @since 5.0
|
|
689
|
+
*/
|
|
534
690
|
length: number;
|
|
535
|
-
/**
|
|
691
|
+
/**
|
|
692
|
+
* The location of the center of the jog, as a percentage measured from the start of the input geometry.
|
|
693
|
+
*
|
|
694
|
+
* @since 5.0
|
|
695
|
+
*/
|
|
536
696
|
position: number;
|
|
697
|
+
/** @since 5.0 */
|
|
537
698
|
type: "CIMGeometricEffectJog";
|
|
538
699
|
}
|
|
539
700
|
|
|
@@ -556,14 +717,17 @@ export interface CIMGeometricEffectMove extends CIMGeometricEffectBase {
|
|
|
556
717
|
* The distance in points to move the symbol along the X-axis of the feature geometry.
|
|
557
718
|
*
|
|
558
719
|
* @default 1
|
|
720
|
+
* @since 5.0
|
|
559
721
|
*/
|
|
560
722
|
offsetX: number;
|
|
561
723
|
/**
|
|
562
724
|
* The distance in points to move the symbol along the Y-axis of the feature geometry.
|
|
563
725
|
*
|
|
564
726
|
* @default -1
|
|
727
|
+
* @since 5.0
|
|
565
728
|
*/
|
|
566
729
|
offsetY: number;
|
|
730
|
+
/** @since 5.0 */
|
|
567
731
|
type: "CIMGeometricEffectMove";
|
|
568
732
|
}
|
|
569
733
|
|
|
@@ -587,16 +751,23 @@ export interface CIMGeometricEffectOffset extends CIMGeometricEffectBase {
|
|
|
587
751
|
* The way strokes or fills are displayed at corners.
|
|
588
752
|
*
|
|
589
753
|
* @default "Square"
|
|
754
|
+
* @since 5.0
|
|
590
755
|
*/
|
|
591
756
|
method: CIMGeometricEffectOffsetMethod;
|
|
592
|
-
/**
|
|
757
|
+
/**
|
|
758
|
+
* The distance in points of the symbol perpendicular to the feature geometry.
|
|
759
|
+
*
|
|
760
|
+
* @since 5.0
|
|
761
|
+
*/
|
|
593
762
|
offset: number;
|
|
594
763
|
/**
|
|
595
764
|
* The way the symbol handles complex geometries.
|
|
596
765
|
*
|
|
597
766
|
* @default "Fast"
|
|
767
|
+
* @since 5.0
|
|
598
768
|
*/
|
|
599
769
|
option: CIMGeometricEffectOffsetOption;
|
|
770
|
+
/** @since 5.0 */
|
|
600
771
|
type: "CIMGeometricEffectOffset";
|
|
601
772
|
}
|
|
602
773
|
|
|
@@ -618,14 +789,17 @@ export interface CIMGeometricEffectRadial extends CIMGeometricEffectBase {
|
|
|
618
789
|
* The orientation of the line from the marker. The angle is calculated in a counter-clockwise manner with 0 degrees equal to due east.
|
|
619
790
|
*
|
|
620
791
|
* @default 0
|
|
792
|
+
* @since 5.0
|
|
621
793
|
*/
|
|
622
794
|
angle: number;
|
|
623
795
|
/**
|
|
624
796
|
* The length of the radial line.
|
|
625
797
|
*
|
|
626
798
|
* @default 5
|
|
799
|
+
* @since 5.0
|
|
627
800
|
*/
|
|
628
801
|
length: number;
|
|
802
|
+
/** @since 5.0 */
|
|
629
803
|
type: "CIMGeometricEffectRadial";
|
|
630
804
|
}
|
|
631
805
|
|
|
@@ -644,8 +818,13 @@ export interface CIMGeometricEffectRadial extends CIMGeometricEffectBase {
|
|
|
644
818
|
* @see {@link symbols/cim/CIMTypes!CIMGeometricEffect}
|
|
645
819
|
*/
|
|
646
820
|
export interface CIMGeometricEffectRotate extends CIMGeometricEffectBase {
|
|
647
|
-
/**
|
|
821
|
+
/**
|
|
822
|
+
* The amount of rotation for the symbol.
|
|
823
|
+
*
|
|
824
|
+
* @since 5.0
|
|
825
|
+
*/
|
|
648
826
|
angle: number;
|
|
827
|
+
/** @since 5.0 */
|
|
649
828
|
type: "CIMGeometricEffectRotate";
|
|
650
829
|
}
|
|
651
830
|
|
|
@@ -667,17 +846,20 @@ export interface CIMGeometricEffectRotate extends CIMGeometricEffectBase {
|
|
|
667
846
|
* @see {@link symbols/cim/CIMTypes!CIMGeometricEffect}
|
|
668
847
|
*/
|
|
669
848
|
export interface CIMGeometricEffectScale extends CIMGeometricEffectBase {
|
|
849
|
+
/** @since 5.0 */
|
|
670
850
|
type: "CIMGeometricEffectScale";
|
|
671
851
|
/**
|
|
672
852
|
* The amount of change in size of a symbol in the x-axis. The value is expressed in terms of a ratio/percentage.
|
|
673
853
|
*
|
|
674
854
|
* @default 1.15
|
|
855
|
+
* @since 5.0
|
|
675
856
|
*/
|
|
676
857
|
xScaleFactor: number;
|
|
677
858
|
/**
|
|
678
859
|
* The amount of change in size of a symbol in the y-axis. The value is expressed in terms of a ratio/percentage.
|
|
679
860
|
*
|
|
680
861
|
* @default 1.15
|
|
862
|
+
* @since 5.0
|
|
681
863
|
*/
|
|
682
864
|
yScaleFactor: number;
|
|
683
865
|
}
|
|
@@ -693,14 +875,17 @@ export interface CIMGeometricEffectSuppress extends CIMGeometricEffectBase {
|
|
|
693
875
|
* A value indicating whether to invert the suppression process. If this value is `true`, portions of the stroke symbol between the control points are kept and all other portions are suppressed.
|
|
694
876
|
*
|
|
695
877
|
* @default false
|
|
878
|
+
* @since 5.0
|
|
696
879
|
*/
|
|
697
880
|
invert: boolean;
|
|
698
881
|
/**
|
|
699
882
|
* A value indicating whether the portion of the stroke symbol between control points should be suppressed. Sections that are suppressed draw with no symbol.
|
|
700
883
|
*
|
|
701
884
|
* @default false
|
|
885
|
+
* @since 5.0
|
|
702
886
|
*/
|
|
703
887
|
suppress: boolean;
|
|
888
|
+
/** @since 5.0 */
|
|
704
889
|
type: "CIMGeometricEffectSuppress";
|
|
705
890
|
}
|
|
706
891
|
|
|
@@ -715,20 +900,24 @@ export interface CIMGeometricEffectTaperedPolygon extends CIMGeometricEffectBase
|
|
|
715
900
|
* The width at the start of the line to be used to generate the polygon.
|
|
716
901
|
*
|
|
717
902
|
* @default 0
|
|
903
|
+
* @since 5.0
|
|
718
904
|
*/
|
|
719
905
|
fromWidth: number;
|
|
720
906
|
/**
|
|
721
907
|
* The distance along the line to be used to generate the polygon.
|
|
722
908
|
*
|
|
723
909
|
* @default 0
|
|
910
|
+
* @since 5.0
|
|
724
911
|
*/
|
|
725
912
|
length: number;
|
|
726
913
|
/**
|
|
727
914
|
* The width at the end of the line to be used to generate the polygon.
|
|
728
915
|
*
|
|
729
916
|
* @default 1
|
|
917
|
+
* @since 5.0
|
|
730
918
|
*/
|
|
731
919
|
toWidth: number;
|
|
920
|
+
/** @since 5.0 */
|
|
732
921
|
type: "CIMGeometricEffectTaperedPolygon";
|
|
733
922
|
}
|
|
734
923
|
|
|
@@ -756,29 +945,35 @@ export interface CIMGeometricEffectWave extends CIMGeometricEffectBase {
|
|
|
756
945
|
* The distance perpendicular to a feature to display the curves for the symbol.
|
|
757
946
|
*
|
|
758
947
|
* @default 2
|
|
948
|
+
* @since 5.0
|
|
759
949
|
*/
|
|
760
950
|
amplitude: number;
|
|
761
951
|
/**
|
|
762
952
|
* The distance along the line or polygon to display the curves for the symbol.
|
|
763
953
|
*
|
|
764
954
|
* @default 3
|
|
955
|
+
* @since 5.0
|
|
765
956
|
*/
|
|
766
957
|
period: number;
|
|
767
958
|
/**
|
|
768
959
|
* The starting value for generating a random number. This is only used when the `waveform` is set to `"Random"`.
|
|
769
960
|
*
|
|
770
961
|
* @default 1
|
|
962
|
+
* @since 5.0
|
|
771
963
|
*/
|
|
772
964
|
seed: number;
|
|
965
|
+
/** @since 5.0 */
|
|
773
966
|
type: "CIMGeometricEffectWave";
|
|
774
967
|
/**
|
|
775
968
|
* The shape of the curves to be displayed along the symbol.
|
|
776
969
|
*
|
|
777
970
|
* @default "Sinus"
|
|
971
|
+
* @since 5.0
|
|
778
972
|
*/
|
|
779
973
|
waveform: CIMGeometricEffectWaveform;
|
|
780
974
|
}
|
|
781
975
|
|
|
976
|
+
/** @since 5.0 */
|
|
782
977
|
export interface CIMFill extends CIMSymbolLayer {}
|
|
783
978
|
|
|
784
979
|
/**
|
|
@@ -818,63 +1013,82 @@ export interface CIMGradientFill extends CIMFill {
|
|
|
818
1013
|
* The angle of the gradient when the GradientMethod is set to "Linear" or "Rectangular".
|
|
819
1014
|
*
|
|
820
1015
|
* @default 90
|
|
1016
|
+
* @since 5.0
|
|
821
1017
|
*/
|
|
822
1018
|
angle?: number;
|
|
823
|
-
/**
|
|
1019
|
+
/**
|
|
1020
|
+
* The color ramp that is applied to the gradient fill.
|
|
1021
|
+
*
|
|
1022
|
+
* @since 5.0
|
|
1023
|
+
*/
|
|
824
1024
|
colorRamp: CIMColorRampUnion;
|
|
825
1025
|
/**
|
|
826
1026
|
* The method used to specify how the gradient is applied within the fill.
|
|
827
1027
|
*
|
|
828
1028
|
* @default "Linear"
|
|
1029
|
+
* @since 5.0
|
|
829
1030
|
*/
|
|
830
1031
|
gradientMethod: CIMGradientFillMethod;
|
|
831
1032
|
/**
|
|
832
1033
|
* The size which determines the how much of the feature is covered by the color scheme. This is either a percentage of the total area which the color scheme spans (if units are "Relative") or the number of points from the starting point at which the gradient displays (if units are "Absolute").
|
|
833
1034
|
*
|
|
834
1035
|
* @default 75
|
|
1036
|
+
* @since 5.0
|
|
835
1037
|
*/
|
|
836
1038
|
gradientSize?: number;
|
|
837
1039
|
/**
|
|
838
1040
|
* The units which determine if the `gradientSize` is applied with an absolute distance or a relative percentage.
|
|
839
1041
|
*
|
|
840
1042
|
* @default "Relative"
|
|
1043
|
+
* @since 5.0
|
|
841
1044
|
*/
|
|
842
1045
|
gradientSizeUnits?: CIMSymbolUnits;
|
|
843
1046
|
/**
|
|
844
1047
|
* The type which specifies if the gradient is applied with discrete intervals or if it is continuous.
|
|
845
1048
|
*
|
|
846
1049
|
* @default "Discrete"
|
|
1050
|
+
* @since 5.0
|
|
847
1051
|
*/
|
|
848
1052
|
gradientType?: CIMGradientStrokeType;
|
|
849
1053
|
/**
|
|
850
1054
|
* The interval which specifies the number of discrete intervals in the gradient. This property is only applied when the `gradientType` is set to "Discrete".
|
|
851
1055
|
*
|
|
852
1056
|
* @default 5
|
|
1057
|
+
* @since 5.0
|
|
853
1058
|
*/
|
|
854
1059
|
interval?: number;
|
|
1060
|
+
/** @since 5.0 */
|
|
855
1061
|
type: "CIMGradientFill";
|
|
856
1062
|
}
|
|
857
1063
|
|
|
1064
|
+
/** @since 5.0 */
|
|
858
1065
|
export interface CIMStroke extends CIMSymbolLayer {
|
|
859
1066
|
/**
|
|
860
1067
|
* Determines how the stroke should draw at the ends of the geometries.
|
|
861
1068
|
*
|
|
862
1069
|
* @default "Round"
|
|
1070
|
+
* @since 5.0
|
|
863
1071
|
*/
|
|
864
1072
|
capStyle?: CIMLineCapStyle;
|
|
865
1073
|
/**
|
|
866
1074
|
* Determines how the symbol is drawn at the stroke segment connections.
|
|
867
1075
|
*
|
|
868
1076
|
* @default "Round"
|
|
1077
|
+
* @since 5.0
|
|
869
1078
|
*/
|
|
870
1079
|
joinStyle?: CIMLineJoinStyle;
|
|
871
1080
|
/**
|
|
872
1081
|
* The maximum 'sharpness' that is allowed for miter joins. The sharp angle will be clipped and rendered with a bevel join if the spike created by the miter join exceeds the `miterLimit` multiplied by the width of the stroke. This property is only applied to the symbol layer when the `joinStyle` is set to `Miter`.
|
|
873
1082
|
*
|
|
874
1083
|
* @default 4
|
|
1084
|
+
* @since 5.0
|
|
875
1085
|
*/
|
|
876
1086
|
miterLimit?: number;
|
|
877
|
-
/**
|
|
1087
|
+
/**
|
|
1088
|
+
* The width of the stroke.
|
|
1089
|
+
*
|
|
1090
|
+
* @since 5.0
|
|
1091
|
+
*/
|
|
878
1092
|
width: number;
|
|
879
1093
|
}
|
|
880
1094
|
|
|
@@ -910,34 +1124,47 @@ export interface CIMStroke extends CIMSymbolLayer {
|
|
|
910
1124
|
* @since 4.32
|
|
911
1125
|
*/
|
|
912
1126
|
export interface CIMGradientStroke extends CIMStroke {
|
|
913
|
-
/**
|
|
1127
|
+
/**
|
|
1128
|
+
* The color ramp that is applied to the gradient stroke.
|
|
1129
|
+
*
|
|
1130
|
+
* @since 5.0
|
|
1131
|
+
*/
|
|
914
1132
|
colorRamp: CIMColorRampUnion;
|
|
915
|
-
/**
|
|
1133
|
+
/**
|
|
1134
|
+
* The method used to specify how the gradient is applied along the stroke.
|
|
1135
|
+
*
|
|
1136
|
+
* @since 5.0
|
|
1137
|
+
*/
|
|
916
1138
|
gradientMethod?: CIMGradientStrokeMethod;
|
|
917
1139
|
/**
|
|
918
1140
|
* The size which determines the how much of the feature is covered by the color scheme. This is either a percentage of the total area which the color scheme spans (if units are "Relative") or the number of points from the starting point at which the gradient displays (if units are "Absolute").
|
|
919
1141
|
*
|
|
920
1142
|
* @default 75
|
|
1143
|
+
* @since 5.0
|
|
921
1144
|
*/
|
|
922
1145
|
gradientSize?: number;
|
|
923
1146
|
/**
|
|
924
1147
|
* The units which determine if the `gradientSize` is applied with an absolute distance or a relative percentage.
|
|
925
1148
|
*
|
|
926
1149
|
* @default "Relative"
|
|
1150
|
+
* @since 5.0
|
|
927
1151
|
*/
|
|
928
1152
|
gradientSizeUnits?: CIMSymbolUnits;
|
|
929
1153
|
/**
|
|
930
1154
|
* The type which specifies if the gradient is applied with discrete intervals or if it is continuous.
|
|
931
1155
|
*
|
|
932
1156
|
* @default "Discrete"
|
|
1157
|
+
* @since 5.0
|
|
933
1158
|
*/
|
|
934
1159
|
gradientType?: CIMGradientStrokeType;
|
|
935
1160
|
/**
|
|
936
1161
|
* The interval which specifies the number of discrete intervals in the gradient. This property is only applied when the `gradientType` is set to "Discrete".
|
|
937
1162
|
*
|
|
938
1163
|
* @default 5
|
|
1164
|
+
* @since 5.0
|
|
939
1165
|
*/
|
|
940
1166
|
interval?: number;
|
|
1167
|
+
/** @since 5.0 */
|
|
941
1168
|
type: "CIMGradientStroke";
|
|
942
1169
|
}
|
|
943
1170
|
|
|
@@ -968,66 +1195,116 @@ export interface CIMGradientStroke extends CIMStroke {
|
|
|
968
1195
|
* The following image shows a {@link symbols/cim/CIMTypes!CIMPolygonSymbol} with a `CIMHatchFill` symbol layer (as defined in the code snippet above).
|
|
969
1196
|
* 
|
|
970
1197
|
*
|
|
1198
|
+
* @since 5.0
|
|
971
1199
|
* @see {@link symbols/cim/CIMTypes!SymbolLayer}
|
|
972
1200
|
*/
|
|
973
1201
|
export interface CIMHatchFill extends CIMFill {
|
|
974
|
-
/**
|
|
1202
|
+
/**
|
|
1203
|
+
* The line symbol that is used to draw the hatch lines in the fill.
|
|
1204
|
+
*
|
|
1205
|
+
* @since 5.0
|
|
1206
|
+
*/
|
|
975
1207
|
lineSymbol: CIMLineSymbol;
|
|
976
1208
|
/**
|
|
977
1209
|
* How much to move the stroke in points to a new X-position.
|
|
978
1210
|
*
|
|
979
1211
|
* @default 0
|
|
1212
|
+
* @since 5.0
|
|
980
1213
|
*/
|
|
981
1214
|
offsetX: number;
|
|
982
1215
|
/**
|
|
983
1216
|
* How much to move the stroke in points to a new Y-position.
|
|
984
1217
|
*
|
|
985
1218
|
* @default 0
|
|
1219
|
+
* @since 5.0
|
|
986
1220
|
*/
|
|
987
1221
|
offsetY: number;
|
|
988
1222
|
/**
|
|
989
1223
|
* The angle of rotation for all the strokes, in degrees.
|
|
990
1224
|
*
|
|
991
1225
|
* @default 0
|
|
1226
|
+
* @since 5.0
|
|
992
1227
|
*/
|
|
993
1228
|
rotation: number;
|
|
994
|
-
/**
|
|
1229
|
+
/**
|
|
1230
|
+
* The distance between the line symbols in the hatch pattern.
|
|
1231
|
+
*
|
|
1232
|
+
* @since 5.0
|
|
1233
|
+
*/
|
|
995
1234
|
separation: number;
|
|
1235
|
+
/** @since 5.0 */
|
|
996
1236
|
type: "CIMHatchFill";
|
|
997
1237
|
}
|
|
998
1238
|
|
|
1239
|
+
/** @since 5.0 */
|
|
999
1240
|
export interface CIMExpressionInfo {
|
|
1000
|
-
/**
|
|
1241
|
+
/**
|
|
1242
|
+
* An [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression following the specification defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). Expressions in primitive overrides may reference field values using the `$feature` profile variable and must return a number or a string. The value returned from this expression represents the value override for the specified `propertyName`. For example, when overriding a symbol layer's color, you must return a string representing a color (e.g. `"rgb(255,255,255)"`, `"white"`, or `"#ffffff"`). When overriding a size, you must return a number representing the new size of the symbol layer.
|
|
1243
|
+
*
|
|
1244
|
+
* @since 5.0
|
|
1245
|
+
*/
|
|
1001
1246
|
expression: string;
|
|
1002
|
-
/**
|
|
1247
|
+
/**
|
|
1248
|
+
* The name of the expression.
|
|
1249
|
+
*
|
|
1250
|
+
* @since 5.0
|
|
1251
|
+
*/
|
|
1003
1252
|
name?: string;
|
|
1004
|
-
/**
|
|
1253
|
+
/**
|
|
1254
|
+
* The return type of the expression. `"Default"` means the return type of the expression is determined by the consumer using the expression.
|
|
1255
|
+
*
|
|
1256
|
+
* @since 5.0
|
|
1257
|
+
*/
|
|
1005
1258
|
returnType?: CIMExpressionReturnType;
|
|
1006
|
-
/**
|
|
1259
|
+
/**
|
|
1260
|
+
* The human readable text that describes the expression.
|
|
1261
|
+
*
|
|
1262
|
+
* @since 5.0
|
|
1263
|
+
*/
|
|
1007
1264
|
title?: string;
|
|
1265
|
+
/** @since 5.0 */
|
|
1008
1266
|
type: "CIMExpressionInfo";
|
|
1009
1267
|
}
|
|
1010
1268
|
|
|
1011
1269
|
/**
|
|
1012
1270
|
* Represents a symbol reference from the [CIMSymbol#data](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#data) property.
|
|
1013
1271
|
*
|
|
1272
|
+
* @since 5.0
|
|
1014
1273
|
* @see [CIMSymbol#data](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#data)
|
|
1015
1274
|
*/
|
|
1016
1275
|
export interface CIMSymbolReference {
|
|
1017
|
-
/**
|
|
1276
|
+
/**
|
|
1277
|
+
* The maximum scale the symbol reference should be displayed. To show your symbol at all scales, set `minScale` and `maxScale` to `0`.
|
|
1278
|
+
*
|
|
1279
|
+
* @since 4.20
|
|
1280
|
+
* @since 5.0
|
|
1281
|
+
*/
|
|
1018
1282
|
maxScale?: number;
|
|
1019
|
-
/**
|
|
1283
|
+
/**
|
|
1284
|
+
* The minimum scale the symbol reference should be displayed. To show your symbol at all scales, set `minScale` and `maxScale` to `0`.
|
|
1285
|
+
*
|
|
1286
|
+
* @since 4.20
|
|
1287
|
+
* @since 5.0
|
|
1288
|
+
*/
|
|
1020
1289
|
minScale?: number;
|
|
1021
1290
|
/**
|
|
1022
1291
|
* The primitive overrides. These allow you to use [Arcade expressions](https://developers.arcgis.com/javascript/latest/arcade/#visualization) to dynamically change many symbol layer properties
|
|
1023
1292
|
* from data values.
|
|
1293
|
+
*
|
|
1294
|
+
* @since 5.0
|
|
1024
1295
|
*/
|
|
1025
1296
|
primitiveOverrides?: CIMPrimitiveOverride[] | null;
|
|
1026
|
-
/**
|
|
1297
|
+
/**
|
|
1298
|
+
* The symbol. Supported values are CIMPointSymbol, CIMLineSymbol, and CIMPolygonSymbol.
|
|
1299
|
+
*
|
|
1300
|
+
* @since 5.0
|
|
1301
|
+
*/
|
|
1027
1302
|
symbol?: CIMSymbolUnion | null;
|
|
1303
|
+
/** @since 5.0 */
|
|
1028
1304
|
type: "CIMSymbolReference";
|
|
1029
1305
|
}
|
|
1030
1306
|
|
|
1307
|
+
/** @since 5.0 */
|
|
1031
1308
|
export interface CIMSymbol {}
|
|
1032
1309
|
|
|
1033
1310
|
/**
|
|
@@ -1047,18 +1324,32 @@ export interface CIMSymbol {}
|
|
|
1047
1324
|
* > 3. Stroke symbols - CIMSolidStroke, CIMPictureStroke, and CIMGradientStroke
|
|
1048
1325
|
* > 4. Fill symbols - CIMSolidFill, CIMHatchFill, CIMPictureFill, and CIMGradientFill
|
|
1049
1326
|
*
|
|
1327
|
+
* @since 5.0
|
|
1050
1328
|
* @see {@link symbols/cim/CIMTypes!CIMPointSymbol CIMPointSymbol.symbolLayers}
|
|
1051
1329
|
* @see {@link symbols/cim/CIMTypes!CIMLineSymbol CIMLineSymbol.symbolLayers}
|
|
1052
1330
|
* @see {@link symbols/cim/CIMTypes!CIMPolygonSymbol CIMPolygonSymbol.symbolLayers}
|
|
1053
1331
|
*/
|
|
1054
1332
|
export type CIMSymbolLayerUnion = CIMGradientFill | CIMPictureMarker | CIMVectorMarker | CIMGradientStroke | CIMHatchFill | CIMPictureFill | CIMPictureStroke | CIMSolidFill | CIMSolidStroke;
|
|
1055
1333
|
|
|
1334
|
+
/** @since 5.0 */
|
|
1056
1335
|
export interface CIMMultiLayerSymbol extends CIMSymbol {
|
|
1057
|
-
/**
|
|
1336
|
+
/**
|
|
1337
|
+
* The geometric effects applied to the symbol.
|
|
1338
|
+
*
|
|
1339
|
+
* @since 5.0
|
|
1340
|
+
*/
|
|
1058
1341
|
effects?: CIMGeometricEffects;
|
|
1059
|
-
/**
|
|
1342
|
+
/**
|
|
1343
|
+
* The symbol layers. Symbol layers are the components that make up a symbol. A symbol layer is represented by a marker, stroke, or fill symbol layer. Symbol layers are the building blocks of CIM symbols, they combine to make rich graphical depictions. You can configure the shape, color, texture, size, position, etc of each symbol layer, and combine multiple symbol layers to create your desired symbol. The symbol layers are typically displayed in the order they are defined, so the first symbol layer will be displayed on top, and the last symbol layer will be displayed on bottom. There are some limitations to this when working with FeatureLayers - see {@link symbols/cim/CIMTypes!SymbolLayer} for more information.
|
|
1344
|
+
*
|
|
1345
|
+
* @since 5.0
|
|
1346
|
+
*/
|
|
1060
1347
|
symbolLayers?: CIMSymbolLayerUnion[];
|
|
1061
|
-
/**
|
|
1348
|
+
/**
|
|
1349
|
+
* A value indicating whether the symbol size properties are rendered using real world units or page units. When set to `true`, the symbol will draw using real world units (e.g. meters).
|
|
1350
|
+
*
|
|
1351
|
+
* @since 5.0
|
|
1352
|
+
*/
|
|
1062
1353
|
useRealWorldSymbolSizes?: boolean;
|
|
1063
1354
|
}
|
|
1064
1355
|
|
|
@@ -1114,6 +1405,7 @@ export interface CIMMultiLayerSymbol extends CIMSymbol {
|
|
|
1114
1405
|
* @see {@link symbols/cim/CIMTypes!CIMHatchFill CIMHatchFill.lineSymbol}
|
|
1115
1406
|
*/
|
|
1116
1407
|
export interface CIMLineSymbol extends CIMMultiLayerSymbol {
|
|
1408
|
+
/** @since 5.0 */
|
|
1117
1409
|
type: "CIMLineSymbol";
|
|
1118
1410
|
}
|
|
1119
1411
|
|
|
@@ -1127,66 +1419,101 @@ export interface CIMLineSymbol extends CIMMultiLayerSymbol {
|
|
|
1127
1419
|
* >
|
|
1128
1420
|
* > For CIMSymbols in a FeatureLayer, a marker graphic that contains a CIMTextSymbol will always be rendered on top, regardless of its order in the array of graphics.
|
|
1129
1421
|
*
|
|
1422
|
+
* @since 5.0
|
|
1130
1423
|
* @see {@link symbols/cim/CIMTypes!CIMVectorMarker CIMVectorMarker.markerGraphics}
|
|
1131
1424
|
*/
|
|
1132
1425
|
export interface CIMMarkerGraphic {
|
|
1133
|
-
/**
|
|
1426
|
+
/**
|
|
1427
|
+
* The geometry of the marker.
|
|
1428
|
+
*
|
|
1429
|
+
* @since 5.0
|
|
1430
|
+
*/
|
|
1134
1431
|
geometry: any;
|
|
1135
|
-
/**
|
|
1432
|
+
/**
|
|
1433
|
+
* The primitive name.
|
|
1434
|
+
*
|
|
1435
|
+
* @since 5.0
|
|
1436
|
+
*/
|
|
1136
1437
|
primitiveName?: string;
|
|
1137
|
-
/**
|
|
1438
|
+
/**
|
|
1439
|
+
* The symbol used to draw the marker graphic. This can be a point, line, polygon or text symbol.
|
|
1440
|
+
*
|
|
1441
|
+
* @since 5.0
|
|
1442
|
+
*/
|
|
1138
1443
|
symbol?: CIMSymbolUnion;
|
|
1139
|
-
/**
|
|
1444
|
+
/**
|
|
1445
|
+
* The text that is defined within the marker if drawn with a text symbol.
|
|
1446
|
+
*
|
|
1447
|
+
* @since 5.0
|
|
1448
|
+
*/
|
|
1140
1449
|
textString?: string;
|
|
1450
|
+
/** @since 5.0 */
|
|
1141
1451
|
type: "CIMMarkerGraphic";
|
|
1142
1452
|
}
|
|
1143
1453
|
|
|
1454
|
+
/** @since 5.0 */
|
|
1144
1455
|
export interface CIMMarkerPlacementBase {
|
|
1145
1456
|
/**
|
|
1146
1457
|
* A value indicating whether to consider individual geometry parts or the whole geometry.
|
|
1147
1458
|
*
|
|
1148
1459
|
* @default true
|
|
1460
|
+
* @since 5.0
|
|
1149
1461
|
*/
|
|
1150
1462
|
placePerPart: boolean;
|
|
1151
|
-
/**
|
|
1463
|
+
/**
|
|
1464
|
+
* The primitive name.
|
|
1465
|
+
*
|
|
1466
|
+
* @since 5.0
|
|
1467
|
+
*/
|
|
1152
1468
|
primitiveName?: string;
|
|
1153
1469
|
}
|
|
1154
1470
|
|
|
1471
|
+
/** @since 5.0 */
|
|
1155
1472
|
export interface CIMMarkerStrokePlacement extends CIMMarkerPlacementBase {
|
|
1156
1473
|
/**
|
|
1157
1474
|
* A value indicating whether to angle the marker to the line.
|
|
1158
1475
|
*
|
|
1159
1476
|
* @default true
|
|
1477
|
+
* @since 5.0
|
|
1160
1478
|
*/
|
|
1161
1479
|
angleToLine: boolean;
|
|
1162
1480
|
/**
|
|
1163
1481
|
* The offset in points.
|
|
1164
1482
|
*
|
|
1165
1483
|
* @default 0
|
|
1484
|
+
* @since 5.0
|
|
1166
1485
|
*/
|
|
1167
1486
|
offset: number;
|
|
1168
1487
|
}
|
|
1169
1488
|
|
|
1489
|
+
/** @since 5.0 */
|
|
1170
1490
|
export interface CIMMarkerPlacementAlongLine extends CIMMarkerStrokePlacement {
|
|
1171
1491
|
/**
|
|
1172
1492
|
* Where the pattern should end relative to the ending point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the `endings` property is set to `Custom`.
|
|
1173
1493
|
*
|
|
1174
1494
|
* @default 0
|
|
1495
|
+
* @since 5.0
|
|
1175
1496
|
*/
|
|
1176
1497
|
customEndingOffset: number;
|
|
1177
1498
|
/**
|
|
1178
1499
|
* How markers are placed at the end points of a line.
|
|
1179
1500
|
*
|
|
1180
1501
|
* @default "WithHalfGap"
|
|
1502
|
+
* @since 5.0
|
|
1181
1503
|
*/
|
|
1182
1504
|
endings: CIMPlacementEndings;
|
|
1183
1505
|
/**
|
|
1184
1506
|
* Where the pattern should begin relative to the starting point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the `endings` property is set to `No Constraint` or `Custom`.
|
|
1185
1507
|
*
|
|
1186
1508
|
* @default 0
|
|
1509
|
+
* @since 5.0
|
|
1187
1510
|
*/
|
|
1188
1511
|
offsetAlongLine: number;
|
|
1189
|
-
/**
|
|
1512
|
+
/**
|
|
1513
|
+
* The numeric pattern that defines the sequence of placed markers and the length of space between them.
|
|
1514
|
+
*
|
|
1515
|
+
* @since 5.0
|
|
1516
|
+
*/
|
|
1190
1517
|
placementTemplate: number[];
|
|
1191
1518
|
}
|
|
1192
1519
|
|
|
@@ -1210,10 +1537,12 @@ export interface CIMMarkerPlacementAlongLine extends CIMMarkerStrokePlacement {
|
|
|
1210
1537
|
*
|
|
1211
1538
|
* 
|
|
1212
1539
|
*
|
|
1540
|
+
* @since 5.0
|
|
1213
1541
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerPlacement}
|
|
1214
1542
|
* @see [Sample - Arrows along a line](https://developers.arcgis.com/javascript/latest/sample-code/cim-line-arrows/)
|
|
1215
1543
|
*/
|
|
1216
1544
|
export interface CIMMarkerPlacementAlongLineSameSize extends CIMMarkerPlacementAlongLine {
|
|
1545
|
+
/** @since 5.0 */
|
|
1217
1546
|
type: "CIMMarkerPlacementAlongLineSameSize";
|
|
1218
1547
|
}
|
|
1219
1548
|
|
|
@@ -1234,6 +1563,7 @@ export interface CIMMarkerPlacementAlongLineSameSize extends CIMMarkerPlacementA
|
|
|
1234
1563
|
*
|
|
1235
1564
|
* 
|
|
1236
1565
|
*
|
|
1566
|
+
* @since 5.0
|
|
1237
1567
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerPlacement}
|
|
1238
1568
|
*/
|
|
1239
1569
|
export interface CIMMarkerPlacementAtExtremities extends CIMMarkerStrokePlacement {
|
|
@@ -1241,14 +1571,17 @@ export interface CIMMarkerPlacementAtExtremities extends CIMMarkerStrokePlacemen
|
|
|
1241
1571
|
* Which ends of the line a marker will be placed.
|
|
1242
1572
|
*
|
|
1243
1573
|
* @default "Both"
|
|
1574
|
+
* @since 5.0
|
|
1244
1575
|
*/
|
|
1245
1576
|
extremityPlacement: CIMExtremityPlacement;
|
|
1246
1577
|
/**
|
|
1247
1578
|
* The distance (in points) from the ends of a line that the marker will be placed.
|
|
1248
1579
|
*
|
|
1249
1580
|
* @default 0
|
|
1581
|
+
* @since 5.0
|
|
1250
1582
|
*/
|
|
1251
1583
|
offsetAlongLine: number;
|
|
1584
|
+
/** @since 5.0 */
|
|
1252
1585
|
type: "CIMMarkerPlacementAtExtremities";
|
|
1253
1586
|
}
|
|
1254
1587
|
|
|
@@ -1271,6 +1604,7 @@ export interface CIMMarkerPlacementAtExtremities extends CIMMarkerStrokePlacemen
|
|
|
1271
1604
|
*
|
|
1272
1605
|
* 
|
|
1273
1606
|
*
|
|
1607
|
+
* @since 5.0
|
|
1274
1608
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerPlacement}
|
|
1275
1609
|
*/
|
|
1276
1610
|
export interface CIMMarkerPlacementAtRatioPositions extends CIMMarkerStrokePlacement {
|
|
@@ -1278,25 +1612,34 @@ export interface CIMMarkerPlacementAtRatioPositions extends CIMMarkerStrokePlace
|
|
|
1278
1612
|
* The distance from the beginning of a line that the marker will be placed.
|
|
1279
1613
|
*
|
|
1280
1614
|
* @default 0
|
|
1615
|
+
* @since 5.0
|
|
1281
1616
|
*/
|
|
1282
1617
|
beginPosition: number;
|
|
1283
1618
|
/**
|
|
1284
1619
|
* The distance from the end of a line that the marker will be placed. The ending of a line is determined by the direction in which the line was digitized.
|
|
1285
1620
|
*
|
|
1286
1621
|
* @default 0
|
|
1622
|
+
* @since 5.0
|
|
1287
1623
|
*/
|
|
1288
1624
|
endPosition: number;
|
|
1289
1625
|
/**
|
|
1290
1626
|
* A value indicating whether only the first marker will be rotated 180 degrees.
|
|
1291
1627
|
*
|
|
1292
1628
|
* @default true
|
|
1629
|
+
* @since 5.0
|
|
1293
1630
|
*/
|
|
1294
1631
|
flipFirst: boolean;
|
|
1295
|
-
/**
|
|
1632
|
+
/**
|
|
1633
|
+
* The array of positions.
|
|
1634
|
+
*
|
|
1635
|
+
* @since 5.0
|
|
1636
|
+
*/
|
|
1296
1637
|
positionArray: number[];
|
|
1638
|
+
/** @since 5.0 */
|
|
1297
1639
|
type: "CIMMarkerPlacementAtRatioPositions";
|
|
1298
1640
|
}
|
|
1299
1641
|
|
|
1642
|
+
/** @since 5.0 */
|
|
1300
1643
|
export interface CIMMarkerFillPlacement extends CIMMarkerPlacementBase {}
|
|
1301
1644
|
|
|
1302
1645
|
/**
|
|
@@ -1318,58 +1661,81 @@ export interface CIMMarkerFillPlacement extends CIMMarkerPlacementBase {}
|
|
|
1318
1661
|
*
|
|
1319
1662
|
* 
|
|
1320
1663
|
*
|
|
1664
|
+
* @since 5.0
|
|
1321
1665
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerPlacement}
|
|
1322
1666
|
* @see [Sample - Adjust marker placement in polygon symbols](https://developers.arcgis.com/javascript/latest/sample-code/cim-marker-placement/)
|
|
1323
1667
|
*/
|
|
1324
1668
|
export interface CIMMarkerPlacementInsidePolygon extends CIMMarkerFillPlacement {
|
|
1325
|
-
/**
|
|
1669
|
+
/**
|
|
1670
|
+
* The clipping option which specifies how markers should be clipped at the polygon boundary. The markers will always be clipped at the polygon boundary.
|
|
1671
|
+
*
|
|
1672
|
+
* @since 5.0
|
|
1673
|
+
*/
|
|
1326
1674
|
clipping: CIMPlacementClip;
|
|
1327
1675
|
/**
|
|
1328
1676
|
* The orientation angle that the markers are placed on within the polygon.
|
|
1329
1677
|
*
|
|
1330
1678
|
* @default 0
|
|
1679
|
+
* @since 5.0
|
|
1331
1680
|
*/
|
|
1332
1681
|
gridAngle: number;
|
|
1333
1682
|
/**
|
|
1334
1683
|
* The grid type which defines how markers are placed. `Random` is supported as of version 4.24.
|
|
1335
1684
|
*
|
|
1336
1685
|
* @default "Fixed"
|
|
1686
|
+
* @since 5.0
|
|
1337
1687
|
*/
|
|
1338
1688
|
gridType: CIMPlacementGridType;
|
|
1339
1689
|
/**
|
|
1340
1690
|
* The marker row offset horizontally in points.
|
|
1341
1691
|
*
|
|
1342
1692
|
* @default 0
|
|
1693
|
+
* @since 5.0
|
|
1343
1694
|
*/
|
|
1344
1695
|
offsetX: number;
|
|
1345
1696
|
/**
|
|
1346
1697
|
* The marker row offset vertically in points.
|
|
1347
1698
|
*
|
|
1348
1699
|
* @default 0
|
|
1700
|
+
* @since 5.0
|
|
1349
1701
|
*/
|
|
1350
1702
|
offsetY: number;
|
|
1351
1703
|
/**
|
|
1352
|
-
*
|
|
1704
|
+
* A percentage that determines the randomness of markers within the polygon. Accepted values are between 0 and 100, with 0 being the least random and 100 being the most random. Only applied when `gridType` is `Random`.
|
|
1353
1705
|
*
|
|
1354
1706
|
* @default 100
|
|
1707
|
+
* @since 4.24
|
|
1708
|
+
* @since 5.0
|
|
1355
1709
|
*/
|
|
1356
1710
|
randomness: number;
|
|
1357
1711
|
/**
|
|
1358
|
-
*
|
|
1712
|
+
* The starting value for generating a random pattern. Only applied when `gridType` is `Random`.
|
|
1359
1713
|
*
|
|
1360
1714
|
* @default 0
|
|
1715
|
+
* @since 4.24
|
|
1716
|
+
* @since 5.0
|
|
1361
1717
|
*/
|
|
1362
1718
|
seed: number;
|
|
1363
1719
|
/**
|
|
1364
1720
|
* A value indicating whether every other row of markers should be shifted to create an offset grid.
|
|
1365
1721
|
*
|
|
1366
1722
|
* @default false
|
|
1723
|
+
* @since 5.0
|
|
1367
1724
|
*/
|
|
1368
1725
|
shiftOddRows: boolean;
|
|
1369
|
-
/**
|
|
1726
|
+
/**
|
|
1727
|
+
* The distance between each marker on the X-axis of the grid.
|
|
1728
|
+
*
|
|
1729
|
+
* @since 5.0
|
|
1730
|
+
*/
|
|
1370
1731
|
stepX: number;
|
|
1371
|
-
/**
|
|
1732
|
+
/**
|
|
1733
|
+
* The distance between each marker on the Y-axis of the grid.
|
|
1734
|
+
*
|
|
1735
|
+
* @since 5.0
|
|
1736
|
+
*/
|
|
1372
1737
|
stepY: number;
|
|
1738
|
+
/** @since 5.0 */
|
|
1373
1739
|
type: "CIMMarkerPlacementInsidePolygon";
|
|
1374
1740
|
}
|
|
1375
1741
|
|
|
@@ -1390,6 +1756,7 @@ export interface CIMMarkerPlacementInsidePolygon extends CIMMarkerFillPlacement
|
|
|
1390
1756
|
*
|
|
1391
1757
|
* 
|
|
1392
1758
|
*
|
|
1759
|
+
* @since 5.0
|
|
1393
1760
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerPlacement}
|
|
1394
1761
|
*/
|
|
1395
1762
|
export interface CIMMarkerPlacementOnLine extends CIMMarkerStrokePlacement {
|
|
@@ -1397,14 +1764,17 @@ export interface CIMMarkerPlacementOnLine extends CIMMarkerStrokePlacement {
|
|
|
1397
1764
|
* The location on a line where a marker will be placed. The direction of the line is determined by the direction in which the line was digitized.
|
|
1398
1765
|
*
|
|
1399
1766
|
* @default "LineMiddle"
|
|
1767
|
+
* @since 5.0
|
|
1400
1768
|
*/
|
|
1401
1769
|
relativeTo: CIMPlacementOnLineRelativeTo;
|
|
1402
1770
|
/**
|
|
1403
1771
|
* The distance in points from a specified location on a line that a marker will be placed.
|
|
1404
1772
|
*
|
|
1405
1773
|
* @default 0
|
|
1774
|
+
* @since 5.0
|
|
1406
1775
|
*/
|
|
1407
1776
|
startPointOffset: number;
|
|
1777
|
+
/** @since 5.0 */
|
|
1408
1778
|
type: "CIMMarkerPlacementOnLine";
|
|
1409
1779
|
}
|
|
1410
1780
|
|
|
@@ -1425,6 +1795,7 @@ export interface CIMMarkerPlacementOnLine extends CIMMarkerStrokePlacement {
|
|
|
1425
1795
|
*
|
|
1426
1796
|
* 
|
|
1427
1797
|
*
|
|
1798
|
+
* @since 5.0
|
|
1428
1799
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerPlacement}
|
|
1429
1800
|
*/
|
|
1430
1801
|
export interface CIMMarkerPlacementOnVertices extends CIMMarkerStrokePlacement {
|
|
@@ -1432,20 +1803,24 @@ export interface CIMMarkerPlacementOnVertices extends CIMMarkerStrokePlacement {
|
|
|
1432
1803
|
* A value indicating whether a marker will be placed on the control points of the line.
|
|
1433
1804
|
*
|
|
1434
1805
|
* @default true
|
|
1806
|
+
* @since 5.0
|
|
1435
1807
|
*/
|
|
1436
1808
|
placeOnControlPoints: boolean;
|
|
1437
1809
|
/**
|
|
1438
1810
|
* A value indicating whether a marker will be placed on the endpoints of the line.
|
|
1439
1811
|
*
|
|
1440
1812
|
* @default true
|
|
1813
|
+
* @since 5.0
|
|
1441
1814
|
*/
|
|
1442
1815
|
placeOnEndPoints: boolean;
|
|
1443
1816
|
/**
|
|
1444
1817
|
* A value indicating whether a marker will be placed on the vertices of the line.
|
|
1445
1818
|
*
|
|
1446
1819
|
* @default true
|
|
1820
|
+
* @since 5.0
|
|
1447
1821
|
*/
|
|
1448
1822
|
placeOnRegularVertices: boolean;
|
|
1823
|
+
/** @since 5.0 */
|
|
1449
1824
|
type: "CIMMarkerPlacementOnVertices";
|
|
1450
1825
|
}
|
|
1451
1826
|
|
|
@@ -1466,6 +1841,7 @@ export interface CIMMarkerPlacementOnVertices extends CIMMarkerStrokePlacement {
|
|
|
1466
1841
|
*
|
|
1467
1842
|
* 
|
|
1468
1843
|
*
|
|
1844
|
+
* @since 5.0
|
|
1469
1845
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerPlacement}
|
|
1470
1846
|
*/
|
|
1471
1847
|
export interface CIMMarkerPlacementPolygonCenter extends CIMMarkerFillPlacement {
|
|
@@ -1473,26 +1849,31 @@ export interface CIMMarkerPlacementPolygonCenter extends CIMMarkerFillPlacement
|
|
|
1473
1849
|
* A value indicating whether the marker should be clipped if it extends pasts the boundary of the polygon.
|
|
1474
1850
|
*
|
|
1475
1851
|
* @default false
|
|
1852
|
+
* @since 5.0
|
|
1476
1853
|
*/
|
|
1477
1854
|
clipAtBoundary: boolean;
|
|
1478
1855
|
/**
|
|
1479
1856
|
* The method used to determine the polygon center.
|
|
1480
1857
|
*
|
|
1481
1858
|
* @default "OnPolygon"
|
|
1859
|
+
* @since 5.0
|
|
1482
1860
|
*/
|
|
1483
1861
|
method: CIMPlacementPolygonCenterMethod;
|
|
1484
1862
|
/**
|
|
1485
1863
|
* The value which offsets the marker horizontally from the center in points.
|
|
1486
1864
|
*
|
|
1487
1865
|
* @default 0
|
|
1866
|
+
* @since 5.0
|
|
1488
1867
|
*/
|
|
1489
1868
|
offsetX: number;
|
|
1490
1869
|
/**
|
|
1491
1870
|
* The value which offsets the marker vertically from the center in points.
|
|
1492
1871
|
*
|
|
1493
1872
|
* @default 0
|
|
1873
|
+
* @since 5.0
|
|
1494
1874
|
*/
|
|
1495
1875
|
offsetY: number;
|
|
1876
|
+
/** @since 5.0 */
|
|
1496
1877
|
type: "CIMMarkerPlacementPolygonCenter";
|
|
1497
1878
|
}
|
|
1498
1879
|
|
|
@@ -1537,45 +1918,64 @@ export interface CIMMarkerPlacementPolygonCenter extends CIMMarkerFillPlacement
|
|
|
1537
1918
|
* }
|
|
1538
1919
|
* ```
|
|
1539
1920
|
*
|
|
1921
|
+
* @since 5.0
|
|
1540
1922
|
* @see {@link symbols/cim/CIMTypes!SymbolLayer}
|
|
1541
1923
|
*/
|
|
1542
1924
|
export interface CIMPictureFill extends CIMFill {
|
|
1543
|
-
/**
|
|
1925
|
+
/**
|
|
1926
|
+
* The color substitutions which allows colors in the image to be substituted with a different color.
|
|
1927
|
+
*
|
|
1928
|
+
* @since 5.0
|
|
1929
|
+
*/
|
|
1544
1930
|
colorSubstitutions?: CIMColorSubstitution[] | null;
|
|
1545
1931
|
/**
|
|
1546
1932
|
* The height of the image in points.
|
|
1547
1933
|
*
|
|
1548
1934
|
* @default 10
|
|
1935
|
+
* @since 5.0
|
|
1549
1936
|
*/
|
|
1550
1937
|
height: number;
|
|
1551
1938
|
/**
|
|
1552
1939
|
* The distance that the image is offset in points in the horizontal direction.
|
|
1553
1940
|
*
|
|
1554
1941
|
* @default 0
|
|
1942
|
+
* @since 5.0
|
|
1555
1943
|
*/
|
|
1556
1944
|
offsetX: number;
|
|
1557
1945
|
/**
|
|
1558
1946
|
* The distance that the image is offset in points in the vertical direction.
|
|
1559
1947
|
*
|
|
1560
1948
|
* @default 0
|
|
1949
|
+
* @since 5.0
|
|
1561
1950
|
*/
|
|
1562
1951
|
offsetY: number;
|
|
1563
1952
|
/**
|
|
1564
1953
|
* The angle of the image within the fill.
|
|
1565
1954
|
*
|
|
1566
1955
|
* @default 0
|
|
1956
|
+
* @since 5.0
|
|
1567
1957
|
*/
|
|
1568
1958
|
rotation: number;
|
|
1569
1959
|
/**
|
|
1570
1960
|
* The width of the symbol without changing the height, as a ratio. For example, a `scaleX` value of `1` means no change, `0.5` means half the width, and `2` means double the width.
|
|
1571
1961
|
*
|
|
1572
1962
|
* @default 1
|
|
1963
|
+
* @since 5.0
|
|
1573
1964
|
*/
|
|
1574
1965
|
scaleX: number;
|
|
1575
|
-
/**
|
|
1966
|
+
/**
|
|
1967
|
+
* The color that is applied as a tint to the image. The color is applied to the whole image. When the tint is set to white the image appears with its native colors. Value should be an array of r,b,g,a values (i.e. `[255,255,255,255]` (white)).
|
|
1968
|
+
*
|
|
1969
|
+
* @since 5.0
|
|
1970
|
+
*/
|
|
1576
1971
|
tintColor?: CIMColor | null;
|
|
1972
|
+
/** @since 5.0 */
|
|
1577
1973
|
type: "CIMPictureFill";
|
|
1578
|
-
/**
|
|
1974
|
+
/**
|
|
1975
|
+
* The url of the image. Typically a base64 encoded image.
|
|
1976
|
+
*
|
|
1977
|
+
* @since 5.0
|
|
1978
|
+
*/
|
|
1579
1979
|
url: string;
|
|
1580
1980
|
}
|
|
1581
1981
|
|
|
@@ -1601,23 +2001,43 @@ export interface CIMPictureFill extends CIMFill {
|
|
|
1601
2001
|
* }
|
|
1602
2002
|
* ```
|
|
1603
2003
|
*
|
|
2004
|
+
* @since 5.0
|
|
1604
2005
|
* @see {@link symbols/cim/CIMTypes!SymbolLayer}
|
|
1605
2006
|
*/
|
|
1606
2007
|
export interface CIMPictureMarker extends CIMMarker {
|
|
1607
|
-
/**
|
|
2008
|
+
/**
|
|
2009
|
+
* The collection of symbol properties that apply when the symbol layer has animation data (animated GIF or PNG).
|
|
2010
|
+
*
|
|
2011
|
+
* @since 4.24
|
|
2012
|
+
* @since 5.0
|
|
2013
|
+
*/
|
|
1608
2014
|
animatedSymbolProperties?: CIMAnimatedSymbolProperties;
|
|
1609
|
-
/**
|
|
2015
|
+
/**
|
|
2016
|
+
* The color substitutions which allows colors in the image to be substituted with a different color.
|
|
2017
|
+
*
|
|
2018
|
+
* @since 5.0
|
|
2019
|
+
*/
|
|
1610
2020
|
colorSubstitutions?: CIMColorSubstitution[];
|
|
1611
2021
|
/**
|
|
1612
2022
|
* The width of the symbol without changing the height, as a ratio. For example, a `scaleX` value of `1` means no change, `0.5` means half the width, and `2` means double the width.
|
|
1613
2023
|
*
|
|
1614
2024
|
* @default 1
|
|
2025
|
+
* @since 5.0
|
|
1615
2026
|
*/
|
|
1616
2027
|
scaleX: number;
|
|
1617
|
-
/**
|
|
2028
|
+
/**
|
|
2029
|
+
* The color that is applied as a tint to the image. The color is applied to the whole image. When the tint is set to white the image appears with its native colors. Value should be an array of r,b,g,a values (i.e. `[255,255,255,255]` (white)).
|
|
2030
|
+
*
|
|
2031
|
+
* @since 5.0
|
|
2032
|
+
*/
|
|
1618
2033
|
tintColor?: CIMColor | null;
|
|
2034
|
+
/** @since 5.0 */
|
|
1619
2035
|
type: "CIMPictureMarker";
|
|
1620
|
-
/**
|
|
2036
|
+
/**
|
|
2037
|
+
* The url of the image. Typically a base64 encoded image.
|
|
2038
|
+
*
|
|
2039
|
+
* @since 5.0
|
|
2040
|
+
*/
|
|
1621
2041
|
url: string;
|
|
1622
2042
|
}
|
|
1623
2043
|
|
|
@@ -1634,28 +2054,70 @@ export interface CIMPictureMarker extends CIMMarker {
|
|
|
1634
2054
|
* @see {@link symbols/cim/CIMTypes!CIMSymbolAnimationOffset}
|
|
1635
2055
|
*/
|
|
1636
2056
|
export interface CIMAnimatedSymbolProperties {
|
|
1637
|
-
/**
|
|
2057
|
+
/**
|
|
2058
|
+
* The time (in seconds) it take to play through the symbol's animation once. This determines a symbol's playback speed.
|
|
2059
|
+
*
|
|
2060
|
+
* @since 5.0
|
|
2061
|
+
*/
|
|
1638
2062
|
duration?: number;
|
|
1639
|
-
/**
|
|
2063
|
+
/**
|
|
2064
|
+
* The easing method to use when animating the symbol. Only for use with {@link symbols/cim/CIMTypes!CIMSymbolAnimation}, not animated GIFs/PNGs.
|
|
2065
|
+
*
|
|
2066
|
+
* @since 4.31
|
|
2067
|
+
* @since 5.0
|
|
2068
|
+
*/
|
|
1640
2069
|
easing?: CIMAnimatedSymbolEasingType;
|
|
1641
|
-
/**
|
|
2070
|
+
/**
|
|
2071
|
+
* Indicates whether the animated symbol should play its animation.
|
|
2072
|
+
*
|
|
2073
|
+
* @since 5.0
|
|
2074
|
+
*/
|
|
1642
2075
|
playAnimation?: boolean;
|
|
1643
|
-
/**
|
|
2076
|
+
/**
|
|
2077
|
+
* The starting value for generating a random number. Used by the `randomizeStartTime` property to determine the time offset for each feature.
|
|
2078
|
+
*
|
|
2079
|
+
* @since 5.0
|
|
2080
|
+
*/
|
|
1644
2081
|
randomizeStartSeed?: number;
|
|
1645
|
-
/**
|
|
2082
|
+
/**
|
|
2083
|
+
* Indicates whether to generate a randomized start offset in seconds to apply to the symbol animation of each feature.
|
|
2084
|
+
*
|
|
2085
|
+
* @since 5.0
|
|
2086
|
+
*/
|
|
1646
2087
|
randomizeStartTime?: boolean;
|
|
1647
|
-
/**
|
|
2088
|
+
/**
|
|
2089
|
+
* The number of seconds to delay before repeating an animation cycle.
|
|
2090
|
+
*
|
|
2091
|
+
* @since 5.0
|
|
2092
|
+
*/
|
|
1648
2093
|
repeatDelay?: number;
|
|
1649
|
-
/**
|
|
2094
|
+
/**
|
|
2095
|
+
* Determines how to repeat the animation of a symbol when the animation cycle ends.
|
|
2096
|
+
*
|
|
2097
|
+
* @since 5.0
|
|
2098
|
+
*/
|
|
1650
2099
|
repeatType?: CIMAnimatedSymbolRepeatType;
|
|
1651
|
-
/**
|
|
2100
|
+
/**
|
|
2101
|
+
* Indicates whether the animated symbol should play back in reverse.
|
|
2102
|
+
*
|
|
2103
|
+
* @since 5.0
|
|
2104
|
+
*/
|
|
1652
2105
|
reverseAnimation?: boolean;
|
|
1653
|
-
/**
|
|
2106
|
+
/**
|
|
2107
|
+
* The time offset in seconds to use as the starting point of the symbol animation. This is used if `randomizeStartTime` is `false`.
|
|
2108
|
+
*
|
|
2109
|
+
* @since 5.0
|
|
2110
|
+
*/
|
|
1654
2111
|
startTimeOffset?: number;
|
|
1655
2112
|
}
|
|
1656
2113
|
|
|
2114
|
+
/** @since 5.0 */
|
|
1657
2115
|
export interface CIMBaseAnimation {
|
|
1658
|
-
/**
|
|
2116
|
+
/**
|
|
2117
|
+
* The properties that apply when the symbol layer has animation data.
|
|
2118
|
+
*
|
|
2119
|
+
* @since 5.0
|
|
2120
|
+
*/
|
|
1659
2121
|
animatedSymbolProperties?: CIMAnimatedSymbolProperties;
|
|
1660
2122
|
}
|
|
1661
2123
|
|
|
@@ -1666,9 +2128,17 @@ export interface CIMBaseAnimation {
|
|
|
1666
2128
|
* @see {@link symbols/cim/CIMTypes!CIMSymbolAnimation}
|
|
1667
2129
|
*/
|
|
1668
2130
|
export interface CIMSymbolAnimationSize extends CIMBaseAnimation {
|
|
1669
|
-
/**
|
|
2131
|
+
/**
|
|
2132
|
+
* The size of the symbol to animate to in points.
|
|
2133
|
+
*
|
|
2134
|
+
* @since 5.0
|
|
2135
|
+
*/
|
|
1670
2136
|
toSize: number;
|
|
1671
|
-
/**
|
|
2137
|
+
/**
|
|
2138
|
+
* The type of animation.
|
|
2139
|
+
*
|
|
2140
|
+
* @since 5.0
|
|
2141
|
+
*/
|
|
1672
2142
|
type: "CIMSymbolAnimationSize";
|
|
1673
2143
|
}
|
|
1674
2144
|
|
|
@@ -1680,9 +2150,17 @@ export interface CIMSymbolAnimationSize extends CIMBaseAnimation {
|
|
|
1680
2150
|
* @see {@link symbols/cim/CIMTypes!CIMSymbolAnimation}
|
|
1681
2151
|
*/
|
|
1682
2152
|
export interface CIMSymbolAnimationScale extends CIMBaseAnimation {
|
|
1683
|
-
/**
|
|
2153
|
+
/**
|
|
2154
|
+
* The scale of the symbol to animate to. For example, a `scaleFactor` of 2 will animate the symbol to twice its original size, and a `scaleFactor` of 0.5 will animate the symbol to half of its original size.
|
|
2155
|
+
*
|
|
2156
|
+
* @since 5.0
|
|
2157
|
+
*/
|
|
1684
2158
|
scaleFactor: number;
|
|
1685
|
-
/**
|
|
2159
|
+
/**
|
|
2160
|
+
* The type of animation.
|
|
2161
|
+
*
|
|
2162
|
+
* @since 5.0
|
|
2163
|
+
*/
|
|
1686
2164
|
type: "CIMSymbolAnimationScale";
|
|
1687
2165
|
}
|
|
1688
2166
|
|
|
@@ -1693,9 +2171,17 @@ export interface CIMSymbolAnimationScale extends CIMBaseAnimation {
|
|
|
1693
2171
|
* @see {@link symbols/cim/CIMTypes!CIMSymbolAnimation}
|
|
1694
2172
|
*/
|
|
1695
2173
|
export interface CIMSymbolAnimationColor extends CIMBaseAnimation {
|
|
1696
|
-
/**
|
|
2174
|
+
/**
|
|
2175
|
+
* The color of the symbol to animate to.
|
|
2176
|
+
*
|
|
2177
|
+
* @since 5.0
|
|
2178
|
+
*/
|
|
1697
2179
|
toColor: CIMColor;
|
|
1698
|
-
/**
|
|
2180
|
+
/**
|
|
2181
|
+
* The type of animation.
|
|
2182
|
+
*
|
|
2183
|
+
* @since 5.0
|
|
2184
|
+
*/
|
|
1699
2185
|
type: "CIMSymbolAnimationColor";
|
|
1700
2186
|
}
|
|
1701
2187
|
|
|
@@ -1707,9 +2193,17 @@ export interface CIMSymbolAnimationColor extends CIMBaseAnimation {
|
|
|
1707
2193
|
* @see {@link symbols/cim/CIMTypes!CIMSymbolAnimation}
|
|
1708
2194
|
*/
|
|
1709
2195
|
export interface CIMSymbolAnimationTransparency extends CIMBaseAnimation {
|
|
1710
|
-
/**
|
|
2196
|
+
/**
|
|
2197
|
+
* The transparency of the symbol to animate to.
|
|
2198
|
+
*
|
|
2199
|
+
* @since 5.0
|
|
2200
|
+
*/
|
|
1711
2201
|
toTransparency: number;
|
|
1712
|
-
/**
|
|
2202
|
+
/**
|
|
2203
|
+
* The type of animation.
|
|
2204
|
+
*
|
|
2205
|
+
* @since 5.0
|
|
2206
|
+
*/
|
|
1713
2207
|
type: "CIMSymbolAnimationTransparency";
|
|
1714
2208
|
}
|
|
1715
2209
|
|
|
@@ -1721,14 +2215,24 @@ export interface CIMSymbolAnimationTransparency extends CIMBaseAnimation {
|
|
|
1721
2215
|
*/
|
|
1722
2216
|
export interface CIMSymbolAnimationRotation extends CIMBaseAnimation {
|
|
1723
2217
|
/**
|
|
1724
|
-
*
|
|
2218
|
+
* A value indicating whether the rotation is applied clockwise or counterclockwise.
|
|
1725
2219
|
*
|
|
1726
2220
|
* @default false
|
|
2221
|
+
* @since 4.32
|
|
2222
|
+
* @since 5.0
|
|
1727
2223
|
*/
|
|
1728
2224
|
rotateClockwise: boolean;
|
|
1729
|
-
/**
|
|
2225
|
+
/**
|
|
2226
|
+
* The rotation of the symbol to animate to.
|
|
2227
|
+
*
|
|
2228
|
+
* @since 5.0
|
|
2229
|
+
*/
|
|
1730
2230
|
toRotation: number;
|
|
1731
|
-
/**
|
|
2231
|
+
/**
|
|
2232
|
+
* The type of animation.
|
|
2233
|
+
*
|
|
2234
|
+
* @since 5.0
|
|
2235
|
+
*/
|
|
1732
2236
|
type: "CIMSymbolAnimationRotation";
|
|
1733
2237
|
}
|
|
1734
2238
|
|
|
@@ -1739,11 +2243,23 @@ export interface CIMSymbolAnimationRotation extends CIMBaseAnimation {
|
|
|
1739
2243
|
* @see {@link symbols/cim/CIMTypes!CIMSymbolAnimation}
|
|
1740
2244
|
*/
|
|
1741
2245
|
export interface CIMSymbolAnimationOffset extends CIMBaseAnimation {
|
|
1742
|
-
/**
|
|
2246
|
+
/**
|
|
2247
|
+
* The x offset of the symbol in points to animate to.
|
|
2248
|
+
*
|
|
2249
|
+
* @since 5.0
|
|
2250
|
+
*/
|
|
1743
2251
|
offsetX: number;
|
|
1744
|
-
/**
|
|
2252
|
+
/**
|
|
2253
|
+
* The y offset of the symbol in points to animate to.
|
|
2254
|
+
*
|
|
2255
|
+
* @since 5.0
|
|
2256
|
+
*/
|
|
1745
2257
|
offsetY: number;
|
|
1746
|
-
/**
|
|
2258
|
+
/**
|
|
2259
|
+
* The type of animation.
|
|
2260
|
+
*
|
|
2261
|
+
* @since 5.0
|
|
2262
|
+
*/
|
|
1747
2263
|
type: "CIMSymbolAnimationOffset";
|
|
1748
2264
|
}
|
|
1749
2265
|
|
|
@@ -1767,6 +2283,7 @@ export interface CIMSymbolAnimationOffset extends CIMBaseAnimation {
|
|
|
1767
2283
|
* > - Global animations are currently only supported on {@link symbols/cim/CIMTypes!CIMPointSymbol}s.
|
|
1768
2284
|
* > - Symbol layer animations are not fully supported within a {@link symbols/cim/CIMTypes!CIMLineSymbol} or {@link symbols/cim/CIMTypes!CIMPolygonSymbol}. If you use an animated marker within a line or polygon symbol, the marker placement will not be properly honored at this time. We will improve this behavior at a future release.
|
|
1769
2285
|
*
|
|
2286
|
+
* @since 5.0
|
|
1770
2287
|
* @see [Sample - Symbol animations](https://developers.arcgis.com/javascript/latest/sample-code/cim-animations/)
|
|
1771
2288
|
* @see {@link symbols/cim/CIMTypes!CIMPointSymbol CIMPointSymbol.animations}
|
|
1772
2289
|
* @see {@link symbols/cim/CIMTypes!CIMPictureMarker CIMPictureMarker.animations}
|
|
@@ -1779,15 +2296,29 @@ export type CIMSymbolAnimation = CIMSymbolAnimationSize | CIMSymbolAnimationScal
|
|
|
1779
2296
|
/**
|
|
1780
2297
|
* Represents a picture stroke which draws linear geometry with a repeating image file. Supported file types are .bmp, .jpg, .png, and .gif.
|
|
1781
2298
|
*
|
|
2299
|
+
* @since 5.0
|
|
1782
2300
|
* @see {@link symbols/cim/CIMTypes!SymbolLayer}
|
|
1783
2301
|
*/
|
|
1784
2302
|
export interface CIMPictureStroke extends CIMStroke {
|
|
1785
|
-
/**
|
|
2303
|
+
/**
|
|
2304
|
+
* The color substitutions which allows colors in the image to be substituted with a different color.
|
|
2305
|
+
*
|
|
2306
|
+
* @since 5.0
|
|
2307
|
+
*/
|
|
1786
2308
|
colorSubstitutions?: CIMColorSubstitution[];
|
|
1787
|
-
/**
|
|
2309
|
+
/**
|
|
2310
|
+
* The color that is applied as a tint to the image. The color is applied to the whole image. When the tint is set to white the image appears with its native colors. Value should be an array of r,b,g,a values (i.e. `[255,255,255,255]` (white)).
|
|
2311
|
+
*
|
|
2312
|
+
* @since 5.0
|
|
2313
|
+
*/
|
|
1788
2314
|
tintColor?: CIMColor;
|
|
2315
|
+
/** @since 5.0 */
|
|
1789
2316
|
type: "CIMPictureStroke";
|
|
1790
|
-
/**
|
|
2317
|
+
/**
|
|
2318
|
+
* The url of the image. Typically a base64 encoded image.
|
|
2319
|
+
*
|
|
2320
|
+
* @since 5.0
|
|
2321
|
+
*/
|
|
1791
2322
|
url: string;
|
|
1792
2323
|
}
|
|
1793
2324
|
|
|
@@ -1835,24 +2366,44 @@ export interface CIMPictureStroke extends CIMStroke {
|
|
|
1835
2366
|
* }
|
|
1836
2367
|
* });
|
|
1837
2368
|
*
|
|
2369
|
+
* @since 5.0
|
|
1838
2370
|
* @see {@link symbols/cim/CIMTypes!CIMSymbolReference CIMSymbolReference.symbol}
|
|
1839
2371
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerGraphic CIMMarkerGraphic.symbol}
|
|
1840
2372
|
*/
|
|
1841
2373
|
export interface CIMPointSymbol extends CIMMultiLayerSymbol {
|
|
1842
|
-
/**
|
|
2374
|
+
/**
|
|
2375
|
+
* The amount of variation applied to the symbol, measured in degrees, propagated cumulatively to all marker symbols.
|
|
2376
|
+
*
|
|
2377
|
+
* @since 5.0
|
|
2378
|
+
*/
|
|
1843
2379
|
angle?: number;
|
|
1844
2380
|
/**
|
|
1845
2381
|
* Indicates whether point symbols align to the map or to the display when a rotation is applied to the map.
|
|
1846
2382
|
*
|
|
1847
2383
|
* @default "Display"
|
|
2384
|
+
* @since 5.0
|
|
1848
2385
|
*/
|
|
1849
2386
|
angleAlignment?: CIMAngleAlignment;
|
|
1850
|
-
/**
|
|
2387
|
+
/**
|
|
2388
|
+
* The animations applied globally to the entire symbol.
|
|
2389
|
+
*
|
|
2390
|
+
* @since 4.31
|
|
2391
|
+
* @since 5.0
|
|
2392
|
+
*/
|
|
1851
2393
|
animations?: CIMSymbolAnimation[];
|
|
1852
|
-
/**
|
|
2394
|
+
/**
|
|
2395
|
+
* The primitive name of the symbol. Used when setting a {@link symbols/cim/CIMTypes!PrimitiveOverride}.
|
|
2396
|
+
*
|
|
2397
|
+
* @since 5.0
|
|
2398
|
+
*/
|
|
1853
2399
|
primitiveName?: string;
|
|
1854
|
-
/**
|
|
2400
|
+
/**
|
|
2401
|
+
* The X scale which changes the width of the symbol without changing the height, as a ratio. For example, a `scaleX` value of `1` means no change, `0.5` means half the width, and `2` means double the width.
|
|
2402
|
+
*
|
|
2403
|
+
* @since 5.0
|
|
2404
|
+
*/
|
|
1855
2405
|
scaleX?: number;
|
|
2406
|
+
/** @since 5.0 */
|
|
1856
2407
|
type: "CIMPointSymbol";
|
|
1857
2408
|
}
|
|
1858
2409
|
|
|
@@ -1933,6 +2484,7 @@ export interface CIMPointSymbol extends CIMMultiLayerSymbol {
|
|
|
1933
2484
|
* @see {@link symbols/cim/CIMTypes!CIMTextSymbol CIMTextSymbol.symbol and CIMTextSymbol.haloSymbol}
|
|
1934
2485
|
*/
|
|
1935
2486
|
export interface CIMPolygonSymbol extends CIMMultiLayerSymbol {
|
|
2487
|
+
/** @since 5.0 */
|
|
1936
2488
|
type: "CIMPolygonSymbol";
|
|
1937
2489
|
}
|
|
1938
2490
|
|
|
@@ -1951,13 +2503,24 @@ export interface CIMPolygonSymbol extends CIMMultiLayerSymbol {
|
|
|
1951
2503
|
* }
|
|
1952
2504
|
* ```
|
|
1953
2505
|
*
|
|
2506
|
+
* @since 5.0
|
|
1954
2507
|
* @see {@link symbols/cim/CIMTypes!SymbolLayer}
|
|
1955
2508
|
*/
|
|
1956
2509
|
export interface CIMSolidFill extends CIMFill {
|
|
1957
|
-
/**
|
|
2510
|
+
/**
|
|
2511
|
+
* The animations applied to the solid fill. Only {@link symbols/cim/CIMTypes!CIMSymbolAnimationColor} is supported.
|
|
2512
|
+
*
|
|
2513
|
+
* @since 4.31
|
|
2514
|
+
* @since 5.0
|
|
2515
|
+
*/
|
|
1958
2516
|
animations?: CIMSymbolAnimationColor[];
|
|
1959
|
-
/**
|
|
2517
|
+
/**
|
|
2518
|
+
* The color that is applied to the fill. Value should be an array of r,b,g,a values (i.e. `[255,255,255,255]` (white)).
|
|
2519
|
+
*
|
|
2520
|
+
* @since 5.0
|
|
2521
|
+
*/
|
|
1960
2522
|
color?: CIMColor;
|
|
2523
|
+
/** @since 5.0 */
|
|
1961
2524
|
type: "CIMSolidFill";
|
|
1962
2525
|
}
|
|
1963
2526
|
|
|
@@ -1981,13 +2544,24 @@ export interface CIMSolidFill extends CIMFill {
|
|
|
1981
2544
|
* }
|
|
1982
2545
|
* ```
|
|
1983
2546
|
*
|
|
2547
|
+
* @since 5.0
|
|
1984
2548
|
* @see {@link symbols/cim/CIMTypes!SymbolLayer}
|
|
1985
2549
|
*/
|
|
1986
2550
|
export interface CIMSolidStroke extends CIMStroke {
|
|
1987
|
-
/**
|
|
2551
|
+
/**
|
|
2552
|
+
* The animations applied to the solid stroke. Only {@link symbols/cim/CIMTypes!CIMSymbolAnimationColor} is supported.
|
|
2553
|
+
*
|
|
2554
|
+
* @since 4.31
|
|
2555
|
+
* @since 5.0
|
|
2556
|
+
*/
|
|
1988
2557
|
animations?: CIMSymbolAnimationColor[];
|
|
1989
|
-
/**
|
|
2558
|
+
/**
|
|
2559
|
+
* The color that is applied to the fill. Value should be an array of r,b,g,a values (i.e. `[255,255,255,255]` (white)).
|
|
2560
|
+
*
|
|
2561
|
+
* @since 5.0
|
|
2562
|
+
*/
|
|
1990
2563
|
color?: CIMColor;
|
|
2564
|
+
/** @since 5.0 */
|
|
1991
2565
|
type: "CIMSolidStroke";
|
|
1992
2566
|
}
|
|
1993
2567
|
|
|
@@ -2046,6 +2620,7 @@ export interface CIMSolidStroke extends CIMStroke {
|
|
|
2046
2620
|
* }
|
|
2047
2621
|
* ```
|
|
2048
2622
|
*
|
|
2623
|
+
* @since 5.0
|
|
2049
2624
|
* @see {@link symbols/cim/CIMTypes!CIMMarkerGraphic CIMMarkerGraphic.symbol}
|
|
2050
2625
|
*/
|
|
2051
2626
|
export interface CIMTextSymbol extends CIMSymbol {
|
|
@@ -2053,53 +2628,93 @@ export interface CIMTextSymbol extends CIMSymbol {
|
|
|
2053
2628
|
* The amount of rotation applied to the text symbol, measured in degrees, around the geometry.
|
|
2054
2629
|
*
|
|
2055
2630
|
* @default 0
|
|
2631
|
+
* @since 5.0
|
|
2056
2632
|
*/
|
|
2057
2633
|
angle?: number;
|
|
2058
|
-
/**
|
|
2634
|
+
/**
|
|
2635
|
+
* The background of the text.
|
|
2636
|
+
*
|
|
2637
|
+
* @since 4.26
|
|
2638
|
+
* @since 5.0
|
|
2639
|
+
*/
|
|
2059
2640
|
callout?: CIMCallout;
|
|
2060
|
-
/**
|
|
2641
|
+
/**
|
|
2642
|
+
* The font family name of the font (e.g. Comic Sans). The possible values are dependent upon if you working with a MapView or SceneView. See the [Labeling guide page](https://developers.arcgis.com/javascript/latest/labeling/) for detailed explanation. Unsupported fonts will fall back to `Arial Unicode MS Regular` in MapView and `sans-serif` in SceneView.
|
|
2643
|
+
*
|
|
2644
|
+
* @since 5.0
|
|
2645
|
+
*/
|
|
2061
2646
|
fontFamilyName?: string;
|
|
2062
|
-
/**
|
|
2647
|
+
/**
|
|
2648
|
+
* The style name for the font family.
|
|
2649
|
+
*
|
|
2650
|
+
* @since 5.0
|
|
2651
|
+
*/
|
|
2063
2652
|
fontStyleName?: "Regular" | "Bold" | "Italic";
|
|
2064
|
-
/**
|
|
2653
|
+
/**
|
|
2654
|
+
* The size of the halo (in points) that extends beyond the symbol shape.
|
|
2655
|
+
*
|
|
2656
|
+
* @since 5.0
|
|
2657
|
+
*/
|
|
2065
2658
|
haloSize?: number | null;
|
|
2066
|
-
/**
|
|
2659
|
+
/**
|
|
2660
|
+
* The polygon symbol that is used to draw the halo for a text symbol.
|
|
2661
|
+
*
|
|
2662
|
+
* @since 5.0
|
|
2663
|
+
*/
|
|
2067
2664
|
haloSymbol?: CIMPolygonSymbol;
|
|
2068
|
-
/**
|
|
2665
|
+
/**
|
|
2666
|
+
* The size of the text in points.
|
|
2667
|
+
*
|
|
2668
|
+
* @since 5.0
|
|
2669
|
+
*/
|
|
2069
2670
|
height?: number;
|
|
2070
2671
|
/**
|
|
2071
2672
|
* The alignment type used to align the text to the geometry horizontally. Affects which side of a point geometry the point text is drawn or which end of a line it is drawn close to. Commonly used to define how stacked text appears.
|
|
2072
2673
|
*
|
|
2073
2674
|
* @default "Left"
|
|
2675
|
+
* @since 5.0
|
|
2074
2676
|
*/
|
|
2075
2677
|
horizontalAlignment?: CIMHorizontalAlignment;
|
|
2076
2678
|
/**
|
|
2077
2679
|
* The X offset in points.
|
|
2078
2680
|
*
|
|
2079
2681
|
* @default 0
|
|
2682
|
+
* @since 5.0
|
|
2080
2683
|
*/
|
|
2081
2684
|
offsetX?: number;
|
|
2082
2685
|
/**
|
|
2083
2686
|
* The Y offset in points.
|
|
2084
2687
|
*
|
|
2085
2688
|
* @default 0
|
|
2689
|
+
* @since 5.0
|
|
2086
2690
|
*/
|
|
2087
2691
|
offsetY?: number;
|
|
2088
2692
|
/**
|
|
2089
2693
|
* A value indicating whether to draw the text with a strike through it.
|
|
2090
2694
|
*
|
|
2091
2695
|
* @default false
|
|
2696
|
+
* @since 5.0
|
|
2092
2697
|
*/
|
|
2093
2698
|
strikethrough?: boolean;
|
|
2094
|
-
/**
|
|
2699
|
+
/**
|
|
2700
|
+
* The polygon symbol that is used to draw the glyphs of the text. Only `CIMSolidFill` symbol layers are supported.
|
|
2701
|
+
*
|
|
2702
|
+
* @since 5.0
|
|
2703
|
+
*/
|
|
2095
2704
|
symbol?: CIMPolygonSymbol;
|
|
2705
|
+
/** @since 5.0 */
|
|
2096
2706
|
type: "CIMTextSymbol";
|
|
2097
|
-
/**
|
|
2707
|
+
/**
|
|
2708
|
+
* A value indicating whether to draw the text with an underline.
|
|
2709
|
+
*
|
|
2710
|
+
* @since 5.0
|
|
2711
|
+
*/
|
|
2098
2712
|
underline?: boolean;
|
|
2099
2713
|
/**
|
|
2100
2714
|
* The vertical alignment of the text.
|
|
2101
2715
|
*
|
|
2102
2716
|
* @default "Bottom"
|
|
2717
|
+
* @since 5.0
|
|
2103
2718
|
*/
|
|
2104
2719
|
verticalAlignment?: CIMVerticalAlignment;
|
|
2105
2720
|
}
|
|
@@ -2155,76 +2770,114 @@ export interface CIMTextSymbol extends CIMSymbol {
|
|
|
2155
2770
|
* }
|
|
2156
2771
|
* ```
|
|
2157
2772
|
*
|
|
2773
|
+
* @since 5.0
|
|
2158
2774
|
* @see {@link symbols/cim/CIMTypes!SymbolLayer}
|
|
2159
2775
|
*/
|
|
2160
2776
|
export interface CIMVectorMarker extends CIMMarker {
|
|
2161
|
-
/**
|
|
2777
|
+
/**
|
|
2778
|
+
* The outer boundary of the entire vector marker.
|
|
2779
|
+
*
|
|
2780
|
+
* @since 5.0
|
|
2781
|
+
*/
|
|
2162
2782
|
frame?: Extent;
|
|
2163
|
-
/**
|
|
2783
|
+
/**
|
|
2784
|
+
* The vector graphics that define the shape of the marker. The marker graphics are typically rendered from bottom to top, so the first marker graphic will be displayed at the bottom, and the last marker graphic will be displayed on top. See {@link symbols/cim/CIMTypes!CIMMarkerGraphic} for limitations with FeatureLayer.
|
|
2785
|
+
*
|
|
2786
|
+
* @since 5.0
|
|
2787
|
+
*/
|
|
2164
2788
|
markerGraphics?: CIMMarkerGraphic[];
|
|
2165
2789
|
/**
|
|
2166
2790
|
* A value indicating whether the frame of the vector marker should be honored when drawing the marker.
|
|
2167
2791
|
*
|
|
2168
2792
|
* @default true
|
|
2793
|
+
* @since 5.0
|
|
2169
2794
|
*/
|
|
2170
2795
|
respectFrame?: boolean;
|
|
2171
2796
|
/**
|
|
2172
2797
|
* A value indicating whether the strokes and or fills of a marker are scaled proportionally when the symbol size is changed. When enabled, the strokes for the outline or fill of the polygon symbol used to draw the marker will be scaled proportionally with changes to the symbol size. If this property is not enabled, then the stroke will draw with the specified width regardless of the marker size.
|
|
2173
2798
|
*
|
|
2174
2799
|
* @default false
|
|
2800
|
+
* @since 5.0
|
|
2175
2801
|
*/
|
|
2176
2802
|
scaleSymbolsProportionally?: boolean;
|
|
2803
|
+
/** @since 5.0 */
|
|
2177
2804
|
type: "CIMVectorMarker";
|
|
2178
2805
|
}
|
|
2179
2806
|
|
|
2807
|
+
/** @since 5.0 */
|
|
2180
2808
|
export type CIMSymbolUnion = CIMPointSymbol | CIMLineSymbol | CIMPolygonSymbol | CIMTextSymbol;
|
|
2181
2809
|
|
|
2810
|
+
/** @since 5.0 */
|
|
2182
2811
|
export type CIMAngleAlignment = "Display" | "Map";
|
|
2183
2812
|
|
|
2813
|
+
/** @since 5.0 */
|
|
2184
2814
|
export type CIMAnimatedSymbolRepeatType = "None" | "Loop" | "Oscillate";
|
|
2185
2815
|
|
|
2816
|
+
/** @since 5.0 */
|
|
2186
2817
|
export type CIMAnimatedSymbolEasingType = "Linear" | "EaseIn" | "EaseOut" | "EaseInOut";
|
|
2187
2818
|
|
|
2819
|
+
/** @since 5.0 */
|
|
2188
2820
|
export type CIMGeometricEffectArrowType = "OpenEnded" | "Block" | "Crossed";
|
|
2189
2821
|
|
|
2822
|
+
/** @since 5.0 */
|
|
2190
2823
|
export type CIMGeometricEffectControlMeasureLineRule = "FullGeometry" | "PerpendicularFromFirstSegment" | "ReversedFirstSegment" | "PerpendicularToSecondSegment" | "SecondSegmentWithTicks" | "DoublePerpendicular" | "OppositeToFirstSegment" | "TriplePerpendicular" | "HalfCircleFirstSegment" | "HalfCircleSecondSegment" | "HalfCircleExtended" | "OpenCircle" | "CoverageEdgesWithTicks" | "GapExtentWithDoubleTicks" | "GapExtentMidline" | "Chevron" | "PerpendicularWithArc" | "ClosedHalfCircle" | "TripleParallelExtended" | "ParallelWithTicks" | "Parallel" | "PerpendicularToFirstSegment" | "ParallelOffset" | "OffsetOpposite" | "OffsetSame" | "CircleWithArc" | "DoubleJog" | "PerpendicularOffset" | "LineExcludingLastSegment" | "MultivertexArrow" | "CrossedArrow" | "ChevronArrow" | "ChevronArrowOffset" | "PartialFirstSegment" | "Arch" | "CurvedParallelTicks" | "Arc90Degrees" | "TipWithPerpendicularAndTicks" | "ConcentricCircles" | "DoubleJogArrow" | "LinkedChevrons" | "SegmentThenHalfCircle" | "LineWithStraightTicks" | "DoubleCurve" | "ParallelWithTicksByWidth" | "EnclosingRoundedRectangle";
|
|
2191
2824
|
|
|
2825
|
+
/** @since 5.0 */
|
|
2192
2826
|
export type CIMGeometricEffectEnclosingPolygonMethod = "ClosePath" | "ConvexHull" | "RectangularBox";
|
|
2193
2827
|
|
|
2828
|
+
/** @since 5.0 */
|
|
2194
2829
|
export type CIMGeometricEffectOffsetMethod = "Mitered" | "Bevelled" | "Rounded" | "Square";
|
|
2195
2830
|
|
|
2831
|
+
/** @since 5.0 */
|
|
2196
2832
|
export type CIMGeometricEffectOffsetOption = "Fast" | "Accurate";
|
|
2197
2833
|
|
|
2834
|
+
/** @since 5.0 */
|
|
2198
2835
|
export type CIMGeometricEffectWaveform = "Sinus" | "Square" | "Triangle" | "Random";
|
|
2199
2836
|
|
|
2837
|
+
/** @since 5.0 */
|
|
2200
2838
|
export type CIMGradientFillMethod = "Linear" | "Rectangular" | "Circular" | "Buffered";
|
|
2201
2839
|
|
|
2840
|
+
/** @since 5.0 */
|
|
2202
2841
|
export type CIMGradientStrokeType = "Discrete" | "Continuous";
|
|
2203
2842
|
|
|
2843
|
+
/** @since 5.0 */
|
|
2204
2844
|
export type CIMGradientStrokeMethod = "AcrossLine" | "AlongLine";
|
|
2205
2845
|
|
|
2846
|
+
/** @since 5.0 */
|
|
2206
2847
|
export type CIMHorizontalAlignment = "Left" | "Right" | "Center" | "Justify";
|
|
2207
2848
|
|
|
2849
|
+
/** @since 5.0 */
|
|
2208
2850
|
export type CIMLineCapStyle = "Butt" | "Round" | "Square";
|
|
2209
2851
|
|
|
2852
|
+
/** @since 5.0 */
|
|
2210
2853
|
export type CIMLineDashEnding = "NoConstraint" | "HalfPattern" | "HalfGap" | "FullPattern" | "FullGap" | "Custom";
|
|
2211
2854
|
|
|
2855
|
+
/** @since 5.0 */
|
|
2212
2856
|
export type CIMLineJoinStyle = "Bevel" | "Round" | "Miter";
|
|
2213
2857
|
|
|
2858
|
+
/** @since 5.0 */
|
|
2214
2859
|
export type CIMExpressionReturnType = "Default" | "String" | "Numeric";
|
|
2215
2860
|
|
|
2861
|
+
/** @since 5.0 */
|
|
2216
2862
|
export type CIMPlacementClip = 0 | 1 | 2 | 3;
|
|
2217
2863
|
|
|
2864
|
+
/** @since 5.0 */
|
|
2218
2865
|
export type CIMPlacementEndings = "NoConstraint" | "WithMarkers" | "WithFullGap" | "WithHalfGap" | "Custom";
|
|
2219
2866
|
|
|
2867
|
+
/** @since 5.0 */
|
|
2220
2868
|
export type CIMPlacementGridType = "Fixed" | "Random" | "RandomFixedQuantity";
|
|
2221
2869
|
|
|
2870
|
+
/** @since 5.0 */
|
|
2222
2871
|
export type CIMPlacementOnLineRelativeTo = "LineMiddle" | "LineBeginning" | "LineEnd" | "SegmentMidpoint";
|
|
2223
2872
|
|
|
2873
|
+
/** @since 5.0 */
|
|
2224
2874
|
export type CIMPlacementPolygonCenterMethod = "OnPolygon" | "CenterOfMass" | "BoundingBoxCenter";
|
|
2225
2875
|
|
|
2876
|
+
/** @since 5.0 */
|
|
2226
2877
|
export type CIMVerticalAlignment = "Top" | "Center" | "Baseline" | "Bottom";
|
|
2227
2878
|
|
|
2879
|
+
/** @since 5.0 */
|
|
2228
2880
|
export type CIMSymbolUnits = "Relative" | "Absolute";
|
|
2229
2881
|
|
|
2882
|
+
/** @since 5.0 */
|
|
2230
2883
|
export type CIMExtremityPlacement = "Both" | "JustBegin" | "JustEnd" | "None";
|