Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove readyPromise and related properties in 1.107 #11195

Closed
ggetz opened this issue Mar 29, 2023 · 2 comments · Fixed by #11379
Closed

Remove readyPromise and related properties in 1.107 #11195

ggetz opened this issue Mar 29, 2023 · 2 comments · Fixed by #11379

Comments

@ggetz
Copy link
Contributor

ggetz commented Mar 29, 2023

#11059 deprecated the readyPromise pattern and some related property throughout the API. The following should be removed:

  • CesiumWidget constructor option options.imageryProvider
  • ImageryProvider.ready and ImageryProvider.readyPromise
  • ImageryProvider.defaultAlpha, ImageryProvider.defaultNightAlpha, ImageryProvider.defaultDayAlpha, ImageryProvider.defaultBrightness, ImageryProvider.defaultContrast, ImageryProvider.defaultHue, ImageryProvider.defaultSaturation, ImageryProvider.defaultGamma, ImageryProvider.defaultMinificationFilter, ImageryProvider.defaultMagnificationFilter
  • ImageryLayer.getViewableRectangle
  • ArcGisMapServerImageryProvider constructor parameter url,ArcGisMapServerImageryProvider.ready, and ArcGisMapServerImageryProvider.readyPromise
  • BingMapsImageryProvider constructor parameter url,BingMapsImageryProvider.ready, and BingMapsImageryProvider.readyPromise
  • GoogleEarthEnterpriseImageryProvider constructor parameters options.url and options.metadata, GoogleEarthEnterpriseImageryProvider.ready, and GoogleEarthEnterpriseImageryProvider.readyPromise
  • GoogleEarthEnterpriseMapsProvider constructor parameters options.url and options.channel, GoogleEarthEnterpriseMapsProvider.ready, and GoogleEarthEnterpriseMapsProvider.readyPromise
  • GridImageryProvider.ready and GridImageryProvider.readyPromise
  • IonImageryProvider constructor parameter assetId,BIonImageryProvider.ready, and IonImageryProvider.readyPromise
  • MapboxImageryProvider.ready and MapboxImageryProvider.readyPromise
  • MapboxStyleImageryProvider.ready and MapboxStyleImageryProvider.readyPromise
  • OpenStreetMapImageryProvider.ready and OpenStreetMapImageryProvider.readyPromise
  • SingleTileImageryProvider.ready and SingleTileImageryProvider.readyPromise
  • TileCoordinatesImageryProvider.ready and TileCoordinatesImageryProvider.readyPromise
  • TileMapServiceImageryProvider constructor parameter options.url, TileMapServiceImageryProvider.ready, and TileMapServiceImageryProvider.readyPromise
  • UrlTemplateImageryProvider.reinitialize, UrlTemplateImageryProvider.ready, and UrlTemplateImageryProvider.readyPromise
  • WebMapServiceImageryProvider.ready, and WebMapServiceImageryProvider.readyPromise
  • WebMapTileServiceImageryProvider.ready, and WebMapTileServiceImageryProvider.readyPromise
  • TerrainProvider.ready and TerrainProvider.readyPromise
  • createWorldImagery was deprecated in CesiumJS 1.104. It will be removed in 1.107. Use createWorldImageryAsync instead.
  • ArcGISTiledElevationTerrainProvider constructor parameter options.url, ArcGISTiledElevationTerrainProvider.ready, and ArcGISTiledElevationTerrainProvider.readyPromise
  • CesiumTerrainProvider constructor parameter options.url, CesiumTerrainProvider.ready, and CesiumTerrainProvider.readyPromise
  • CustomHeightmapTerrainProvider.ready and CustomHeightmapTerrainProvider.readyPromise
  • EllipsoidTerrainProvider.ready, and EllipsoidTerrainProvider.readyPromise
  • GoogleEarthEnterpriseMetadata constructor parameter options.url and GoogleEarthEnterpriseMetadata.readyPromise
  • GoogleEarthEnterpriseTerrainProvider constructor parameters options.url and options.metadata, GoogleEarthEnterpriseTerrainProvider.ready, and GoogleEarthEnterpriseTerrainProvider.readyPromise
  • VRTheWorldTerrainProvider constructor parameter options.url, VRTheWorldTerrainProvider.ready, and VRTheWorldTerrainProvider.readyPromise
  • createWorldTerrain was deprecated in CesiumJS 1.104. It will be removed in 1.107. Use createWorldTerrainAsync instead.
  • Cesium3DTileset constructor parameter options.url, Cesium3DTileset.ready, and Cesium3DTileset.readyPromise
  • createOsmBuildings was deprecated in CesiumJS 1.104. It will be removed in 1.107. Use createOsmBuildingsAsync instead.
  • Model.fromGltf, Model.readyPromise, and Model.texturesLoadedPromise
  • I3SDataProvider construction parameter options.url, I3SDataProvider.ready, and I3SDataProvider.readyPromise
  • TimeDynamicPointCloud.readyPromise
  • VoxelProvider.ready and VoxelProvider.readyPromise
  • Cesium3DTilesVoxelProvider construction parameter options.url, Cesium3DTilesVoxelProvider.ready, and Cesium3DTilesVoxelProvider.readyPromise
  • Primitive.readyPromise, ClassificationPrimitive.readyPromise, GroundPrimitive.readyPromise, and GroundPolylinePrimitive.readyPromise
  • Viewer constructor option options.imageryProvider

There are also several places internally that rely on _readyPromise to ensure backwards compatibility during the deprecation process. These all have comments that call out the removal of readyPromise.

@markw65
Copy link
Contributor

markw65 commented May 20, 2023

I just noticed that there are hundreds of "deprecation warnings" relating to this issue that are somewhat confusing. eg

createWorldTerrain was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use createWorldTerrainAsync instead.

Note that the word "removed" is missing... I count 317 of them. But there are also quite a few with the correct message.

@ggetz
Copy link
Contributor Author

ggetz commented May 26, 2023

Thanks @markw65, the deprecation warnings have been updated in #11311 to include the missing word. It should make it into the 1.106 release.

@ggetz ggetz moved this to In Progress in CesiumJS Issue/PR backlog Jun 16, 2023
@ggetz ggetz moved this from In Progress to Issue/PR closed in CesiumJS Issue/PR backlog Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Issue/PR closed
Development

Successfully merging a pull request may close this issue.

2 participants