@itwin/[email protected]

Beaking changes

• SavedView interface changes
  • Rename id property to savedViewId
  • Remove thumbnail property
  • Move viewData and extensions properties to SavedViewData type
    • Type of viewData has changed and definition has moved to @itwin/saved-views-react
  • Change type of creationTime and lastModified properties to Date | undefined
• Make applySavedView settings easier to understand
  • Remove "reset" from ApplyStrategy union, instead make "clear" a valid value for emphasis and perModelCategoryVisibility properties
  • Remove all property which set default ApplyStrategy of all settings
  • Update documentation
• useSavedViews hook rework
  • No longer implements optimistic behaviour
  • Lazily loads Saved View thumbnails and SavedViewData
  • Can utilize user-supplied external state store
  • All actions now return a promise that resolves on action completion
  • All creation actions now return id of the created entity
  • Rename SavedViewActions type to SavedViewsActions
  • Split submitSavedView into createSavedView and updateSavedView
  • Add lookupSavedViewData action
  • Remove moveToNewGroup and addNewTag actions
• SavedViewTag: Rename id property to tagId
• SavedViewGroup: Rename id property to groupId
• SavedViewsClient interface changes
  • Rename methods
    • getAllSavedViews -> getSavedViews
    • getAllGroups -> getGroups
    • getAllTags -> getTags
    • getSavedView -> getSavedViewById
  • Add getSavedViewDataById method
  • Method argument types now instead of ending in *Params now end in *Args, e.g. CreateSavedViewParams -> CreateSavedViewArgs
  • You can now query all Saved Views that are assigned to a particular group using SavedViewsClient.getSavedViews
  • CreateSavedViewArgs, UpdateSavedViewArgs: Inline properties previously nested within savedView property
  • CreateGroupArgs, UpdateGroupArgs: Inline properties previously nested within group property
  • UpdateTagArgs: Inline properties previously nested within tag property
• <SavedViewTile /> changes
  • Add thumbnail prop
  • Thumbnails that were specified as image URLs now need to be explicitly passed as <img src={url} />
  • onRename callback will no longer send undefined for newName argument

Minor changes

• applySavedView enhancements
  • Accept custom viewChangeOptions that the function will internally pass through to viewport.changeView call
  • Add camera setting that controls how camera data is applied. Allow supplying a custom ViewPose or ignoring Saved View data to keep the camera in place.

Fixes

• Fix captureSavedViewData failing with blank iModel connections
• Replace usage of internal iTwin.js API with public alternative