@caxperts/universal.api v7.1.0

Changelog

Reworked Filetree Implementation

• All interactions for the filetree are now in Application.FileTree, which is now of type FileTreeManager or FileTreeElement and descendants.

Added Features

• FiletreeElement.getContent

  • Retrieves the UPV internal data format for the item. The element can be imported again using FiletreeManager.importContainer.
  • This API is considered very experimental, and only limited support is provided for this function. Use FiletreeElement.getUPVF, FiletreeManager.getUPVF, and FiletreeManager.loadUPVF for normal use cases.

• FiletreeElement.getUPVF

  • Allows you to specify the root of the UPVF file to export, as well as other options.

• FiletreeElement.closeItem

  • Allows you to trigger the close action on an element. Note that this action is not supported on all elements.

• FiletreeElement.editItem

  • Allows you to trigger the edit action on an element. Note that this action is not supported on all elements.
  • Some elements also support starting edit mode without triggering the UI, but this might cause broken behavior on some commands.

• FiletreeElement.showItem

  • Allows you to trigger the show action on an element. Note that this action is not supported on all elements.

• FiletreeElement.viewItem

  • Allows you to trigger the view action on an element. Note that this action is not supported on all elements.

• FiletreeManager.importContainer

  • Used to import a container object retrieved via FiletreeElement.getContent.
  • Please use FiletreeElement.getUPVF, FiletreeManager.getUPVF, and FiletreeManager.loadUPVF for normal use cases.

• FiletreeManager.createSketch

  • Creates a new Sketch in the Filetree.

• FiletreeManager.createMarkup

  • Creates a new Sketch in the Markup.

• FiletreeManager.createComment

  • Creates a new Sketch in the Comment.

• FiletreeManager.createPointOfIntrest

  • Changed the definition to make it easier to use the function

• FileTreeMarkup.setMarkupTool

  • Changes the active tool of the markup as well as the color.

• FileTreeMarkup.getIntelliPidElementsHitByMarkup

  • Can be used to retrieve a list of elements that have been fully drawn over in a markup. Note that the markup needs to be closed (and optionally opened) before running this command.

• FileTreePIDSketch.getCatalogSymbols

  • Retrieve all symbols loaded in UPV.

• FileTreePIDSketch.selectSymbolForPlacement

  • Can select a symbol retrieved via getCatalogSymbols for placement. Can be used to replace the default behavior of the Pid Sketch dialog.

• FileTreePIDSketch.selectPrimitiveForPlacement

  • Can select a primitive for placement. Can be used to replace the default behavior of the Pid Sketch dialog.
  • This function can also be used to trigger functions like breakline or copy element.

• FileTreePIDSketch.SketchColor

  • Change the color of the active sketch. Can be used to replace the default behavior of the Pid Sketch dialog.

• 2D/3D FilterOperation Changable Attributes

  • Added options to load changeable attributes. These are part of Sketch or IntelliPidSketch elements to change attributes like position or rotation.

• Modelobject.setAttribute

  • Added setAttribute to change changeable attributes. Inside the FilterOperation, this option needs to be enabled to work.

• IntelliPidDrawing.openPid

  • Open a Pid.

• IntelliPidDrawing.closePid

  • Close a Pid.

• Model.Pids

  • Retrieve all Pids in the model.

• Model.OpenPids

  • Retrieve all open Pids in the model.

• Model.ActivePid

  • Retrieve the Pid that is currently active or null if none are active.

• Layer2D

  • Added drawing functions for Pid via Layer2D.

• Application.Language

  • Change the language at runtime or retrieve the currently used language.

• Application.Authentication

  • Added an OpenID Connect authentication framework for standalone UPVs and BBV UPVs.
  • Can be used to log in against services like Keycloak or Azure Entra ID.

Improvements

• Performance for 2D/3D FilterOperation
  • getObjects and getSelectedObjects can be faster in certain cases.

Removed Features

• FiletreeManager.createPointOfIntrestWithComment

  • createPointOfIntrestWithComment has been removed in favor of FiletreeManager.createComment and FiletreeManager.createPointOfIntrest.

• IntelliPidDrawing.openIntelliPidDrawings

  • openIntelliPidDrawings was broken in the previous release and has been replaced with IntelliPidDrawing.openPid.

Renamed Features

• Layer
  • Renamed to Layer3D.

Moved Features

• File-based functions to Model.Legacy

  • File-based actions are considered legacy. Please use the Base64 equivalents where possible.

• Application file-based functions to FiletreeManager.Legacy

  • File-based actions are considered legacy. Please use the Base64 equivalents where possible.

• Restuructured Util

  • Multiple classes where moved from Util to Objects