@itwin/saved-views-react@0.9.0

Minor Changes

0.9.0 - 2025-02-06

Add overrides for emphasizeElements extension when apply/capturing saved view@itwin/saved-views-react

@itwin/saved-views-react@0.8.0

Minor Changes

0.8.0 - 2025-02-03

Updated Dependencies:

• Updated all @iTwin packages to be in line with AppUI 5.x
• iTwinUI updated to 3.x
  Important Notice: These updates may cause breaking changes if consumers of this package have not yet updated to the latest versions of these dependencies. Please ensure that you have updated your dependencies to avoid any potential issues.@itwin/saved-views-react

@itwin/saved-views-client@0.5.0

Minor Changes

0.5.0 - 2025-02-03

• Change priority property from PlanarClipMaskProps to be a number instead of restricted to the enum PlanarClipMaskPriority
• Change transformation property from ShapeProps and modelExtents property from ViewITwinDrawing to be optional@itwin/saved-views-client

@itwin/saved-views-react@0.7.0

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

@itwin/saved-views-react@0.6.0

Breaking changes

• SavedViewsClient interface changes
  • Remove getSavedViewInfo method
  • Add getAllSavedViews, getAllGroups, and getAllTags methods as replacement for getSavedViewInfo
  • Rename getSingularSavedView method to getSavedView
• captureSavedViewData now also captures extension data thus return type has now changed to { viewData: ViewData; extensions: SavedViewExtension[] | undefined }
• SavedViewsClient.createSavedView: Update parameter bag to reflect SavedView change (see minor changes)
• SavedViewsClient.updateSavedView: Update parameter bag to reflect SavedView change (see minor changes)
• useSavedViews: Update submitSavedView action parameters to reflect SavedView change (see minor changes)
• Update applySavedView parameter types. savedViewData is now a subset of SavedView object.

Minor changes

• SavedView now also contains optional viewData and extension properties. Objects returned by ITwinSavedViewsClient will have these fields populated.
• Permit ApplySavedViewSettings.viewState value to be "reset". Due to technicalities, it has the same semantics as "apply".
• SavedViewTile: Update placeholder icon

Fixes

• ITwinSavedViewsClient.createSavedView: Extension data now is no longer ignored
• ITwinSavedViewsClient.updateSavedView: Fix extension data not being updated
• ITwinSavedViewsClient.deleteGroup now correctly attempts to delete multiple pages of Saved Views

Dependencies

• Bump @itwin/itwinui-icons-react version requirement from ^2.4.0 to ^2.9.0
• Bump @itwin/saved-views-client version requirement from ^0.3.0 to ^0.4.0

@itwin/saved-views-client@0.4.0

Breaking changes

• SavedViewsClient interface changes
  • getAllSavedViewsMinimal and getAllSavedViewsRepresentation now return AsyncIterableIterator to better emphasize that results are delivered in pages
  • createSavedView and updateSavedView now return SavedViewRepresentationResponse to match the current iTwin API behavior

Fixes

• Remove extensions property from UpdateSavedViewParams because extensions are immutable
• ITwinSavedViewsClient: Fix fetch requests failing when request body contains forbidden characters

@itwin/saved-views-react@0.5.0

Breaking changes

• captureSavedViewData: Remove captureHiddenModelsAndCategories setting from parameter bag. This function now behaves as if its value is always true.
• createViewState: Change function signature to take ViewData instead of SavedViewRepresentation and use parameter bag for additional settings
• Remove experimental ModelCategoryOverrideProvider class
• Remove experimental applyExtensionsToViewport function

Minor changes

• Add applySavedView function
• Promote createViewState to public API

@itwin/saved-views-react@0.4.1

Patch changes

• Expose parameter types used in SavedViewsClient methods

@itwin/saved-views-react@0.4.0

Minor changes

• Add extensions property to SavedView type
• Add creationTime and lastModified properties to SavedView type
• Update ITwinSavedViewsClient to include creationTime and lastModified in getSavedViewInfo, getSingularSavedView, createSavedView, and updateSavedView responses

@itwin/saved-views-react@0.3.1

Fixes

• LayeredMenuItem: Fix chevron not aligning itself with item content

Dependencies

• Bump @itwin/saved-views-client package version from ^0.2.1 to ^0.3.0