API Changes

Changes

Current version: 11i(2024)
Previous version：11i(2023)SP1_WebGL

1. User-Interface Changes:

The Deprecated APIs

Class Name	Deprecated APIs	Description
PBRMaterialtype	NONE	Do not use PBR materials, the enumeration value is 0.
	EMISSION	Use the second texture layer as the emissive texture, with an enumeration value of 4.
	ROUGHNESS	Use the transparency channel of the texture as the roughness for PBR material, with an enumeration value of 8.
S3MTilesLayer	clearMemoryImmediately	Whether memory is released promptly.
	PBRMaterialtype	Get or set the PBR material type.
	setPBRMaterial	Set the PBR material.
	setTextureEmissive()	Set the emissive unit.
	getPointCloudClassificationInfos()	Get the point cloud classification information array.
	setObjsExtendHeight(ids, height)	Set the extrusion height of objects based on the IDS list.
	bReleaseColor	Get the vertex color memory and restore the vertex colors.
	horizontalline	Get or set the horizontal line height.
	horizontalColor	Get or set the horizontal line color.
	layerBounds	Get or set the layer extent. Deprecated the set method, retained the get method.

The New APIs

Class Name	New APIs	Description
SunlightAnalysis	startTime	Get or set the start time of sunlight analysis.
	endTime	Get or set the end time of sunlight analysis.


	visualizationColor	Get or set the display color of the shadow area, with the Alpha value used to adjust the color blending factor. The default color value is (0.0, 0.0, 1.0, 0.7).
	displayMode	Get or set the diaplay mode of the sunlight analysis results, either sunlight ratio or shadow ratio.
	enabled	Get whether sunlight analysis has been enabled.
	run	Start sunlight analysis.
	clear	Clear analysis results.
	setColorTable	Set the color table, type: ColorTable.
	getDurationAsync	Asynchronously get the total duration in seconds that the current location is in the shadow or sunlight.
TiandituTerrainProvider	url	The address of the Tianditu Imagery Service, type: String.
TiandituTerrainProvider	subdomains	The multiple subdomains of the Tianditu, type: Array or String When the subdomains parameter is passed as an Array, it supports loading multiple subdomains. When the subdomains parameter is passed as a String, it only supports loading a single subdomain.
ImageryLayerCollection	getImageryLayerByName	Get the corresponding image layer from the collection based on the layer name, type: String
	removeImageryLayerByName	Remove the corresponding image layer from the collection based on the layer name, type: String
	removeImageryLayerById	Remove the corresponding image layer from the collection based on the layer ID, type: Number
ImageryLayer	name	Get the name of the provider from the image layer, type: String
CloudBox	speed	Get or set the cloud movement speed, type: Number, Default Vaule: 1.0
SkyBox	horizontalRotationAngle	The horizontal rotation angle of the skybox, type: Number, Default Value: 0°
SkyBox	imageUrl	Use a JPG or HDR image to represent the skybox, type: String
Scene	sunlightAnalysis	Get sunlight analysis, type: SunlightAnalysis
Scene	subdomains	The multiple subdomains of MVT, type: Array or String When the subdomains parameter is passed as an Array, it supports loading multiple subdomains. When the subdomains parameter is passed as a String, it only supports loading a single subdomain.
WebMercatorTilingScheme	origin	Set the origin position of the tiles (WMTS service), type: Cartesian3
GeographicTilingScheme	origin	Set the origin position of the tiles(WMTS service), type: Cartographic
SuperMapImageryProvider	prjCoordSys	In dynamic map generation, you can use the specified projection coordinate system provided by the iServer dynamic map service.
HypsometricSetting	colorModulation	Get or set the color value information of Point Cloud, type: ColorModulationInfo
VectorTilesMap	localIdeographFontFamily	Set the font of MVT text annotations to the browser's default font, type: Boolean, Default Value: false
	subdomains	The multiple subdomains of MVT, type: Array or String When the subdomains parameter is passed as an Array, it supports loading multiple subdomains. When the subdomains parameter is passed as a String, it only supports loading a single subdomain.
	setCRS	Set the coordinate system for the third-party MVT data to be integrated, currently supporting EPSG:4490 and EPSG:3857, with the default value being EPSG:4490.
S3MTilesLayer	setCurrentCategoryField	Set the feature value field for Point Cloud, type: String
	getValidCategoryFields	Get the array of valid feature value fields from Point Cloud, type: Array
	waterParameter	Getting the water surface effect parameters, type: WaterParameter
	coveredMap	Get or set the vector tile layer that overlays on the surface of Oblique Photography 3D Model.
WaterParameter	color	Get or set the water surface color, type: Color
	waveDirection	Get or set the water flow direction, with true north as positive and clockwise rotation, ranging from 0 to 360 degrees. type: Number, Default Value: 180°
	waterbodySize	Get or set the water area boundary, type: Number, Default Value: WaterbodySize.MEDIUM
	waveStrength	Get or set the intensity of water ripples, type: Number, Default Value: WaveStrength.MILD

2. The New Classes:

Class Name	Class Summary	Interface Name	Interface Description
SunLightAnalysisMode	A class related to sunlight analysis patterns.	SunlightDuration	Sunlight duration expression pattern, with an enum value of 0
SunLightAnalysisMode	A class related to sunlight analysis patterns.	ShadowDuration	Shadow duration expression pattern, with an enum value of 1
WaterbodySize	A class related to water area boundaries	SMALL	Suitable for describing small water areas (50 meters * 50 meters), with an enum value of 0
		MEDIUM	Suitable for describing medium water areas (100 meters * 100 meters), with an enum value of 1
		LARGE	Suitable for describing large water areas (1000 meters * 1000 meters), with an enum value of 2
WaveStrength	A class related to the intensity of water ripples	CLAM	Calm water surface, with an enum value of 0
		SLIGHT	Slight ripples, with an enum value of 1
		MILD	Moderate ripples, with an enum value of 2
		MODERATE	Significant ripples，with an enum value of 3
ColorModulationInfo	A class related to color value adjustment	maxValue	When using point cloud intensity feature values to set the color table, set the maximum value of the point cloud intensity to the maximum value in the color table, with the default color maximum value being 255.
ColorModulationInfo	A class related to color value adjustment	minValue	When using point cloud intensity feature values to set the color table, set the minimum value of the point cloud intensity to the minimum value in the color table, with the default color miniimum value being 0.
CategoryFieldName	A class related to feature value fields	ClassCode	The category feature value of Point Cloud, with an enumeration value of ClassCode
		Elevation	The elevation feature value of Point Cloud, with an enum value of VertexWeight
		Intensity	The intensity feature value of Point Cloud, with an enum value of PointCloudlntensity

3. Enhancements and Bug Fixes：

Visual effects enchancements:
(1) Now supports setting the movement speed of cloud.
(2) Now supports setting parameters such as water surface color, water flow direction, water area range, and water flow intensity to simulate water bodies like lakes, rivers, and oceans.
(3) Now simplifies the use of skyboxes by supporting the implementation of skybox effects through a single JPG or HDR image.
(4) Now supports setting the horizontal rotation angle of the skybox.
(5) Now supports setting a layered color palette using point cloud intensity feature values, where the maximum/minimum intensity is used as the maximum/minimum value of the color palette. The default maximum value of the color palette is 255, and the minimum is 0.
(6) Now supports seeting a layer color palette for cloud point data that includes feature such as category, intensity, and elevation.
(7) Optimization of model lighting and PBR (Physically Based Rendering) effects, making the model more 3D and realistic.
(8) Now supports particle effect expression of hydrodynamic field models, which can dynamically display the velocity and direction of water flow.
(9) Now supports multi-attribute switching expression in multi-temporal S3M tiles, allowing for dynamic display of changes in properties such as water temperature and depth over time based on a single set of S3M data.
Browser compatibility enhancement:
(10) WebGPU client now supports Chrome version 113 and later.
MVT feature enhancements:
(11) Now supports displaying text annotations with the browser's default font to resolve issues where Mapbox fails to recognize certain fonts, causing text not to display.
(12) Now supports text display based on model or terrain elevation when MVT is aligned with 3D model data from oblique photography.
Online service：
(13) The WMTS service now supports setting the tile origin position to be compatible with the situation where the upper left corner of the image range in the new version of SuperMap iServer does not match the tile origin.
(14) Now supports for loading map data in a 2D scene that is published through ArcGIS dynamic map services and tile map services, using local coordinate systems.

4. New Samples：

Layer_Vector Tile:
(1) MVT(GeoJSON)
Scene：
(2) Layer Catalog Tree
Analysis_3D Spatial Analysis:
(3) Sunlinght Analysis
KML and Model_Model Editing：
(4) Instance Layer Editing
Drawing Online_Geometry Object：
(5) Geometry Object
(6) Dot Icon
(7) Region Style
Visualization_MapV：
(8) Honeycomb Chart
(9) Migration Map
(10) Grid Graph
(11) Flow Chart
(12) Thick Boundary Graph
Visualization_Aggregation：
(13) Aggregation
Visualization_Effect：
(14) Lightning
(15) Electronic Fence
(16) Area Gradient
(17) Radar Scanning
(18) Guangxi Zhuang Autonomous Region Image Topographic Map
(19) Hubei Province Spherical Scene with PBR Materials
（20）Sichuan Province Topographic Map
（21）Sichuan Province Hillshade Map
（22）Yunnan Province Topographic Map
（23）Chongqing Municipality Image Topographic Map
Visualization_Water Flow Simulation:
（24）Multi-factor Water Flow
（25）Water FLow Visualization

The completion date of this document is July 9, 2024. If any content in any previous documents (including electronic and printed documents) does not conform to this document, this document shall prevail. In case this document is updated, the updated version shall prevail.