Changelog
All notable changes to the viktor SDK will be documented in this file, categorized by version number.
The changes can be categorized further in the following headers:
- Action Required: when a backwards incompatible change is made, which requires actions in the application code. This header will only be present in major releases, on Beta features, or when a Python version is dropped.
- Added: when a functionality is added, without breaking compatibility with older versions.
- Deprecated: when an existing functionality will be removed in upcoming releases. You will find a reference to the upgrade instructions in this change.
- Docs: when the change involves SDK documentation, docstring, and/or type hinting.
- Fixed: when the change fixes a bug/error.
- Security: when a vulnerability is fixed.
Each change consists of a tag to annotate which VIKTOR module is involved. If the change encompasses multiple modules,
the viktor tag is used.
v14
v14.27.0 - 09/01/2026
Action Required
viktorRemoved support for Python 3.9
Added
externalAdded elaborate documentation forAutodeskFile.viktorSupport for Python 3.14coreAddedColor.__str__()for direct compatibility with plotly and bokehgeometryAdded convenience methods forGeoPoint,GeoPolyline, andGeoPolygon(iteration, tuple unpacking, subscript access)api_v1AddedFileResource.open()andopen_binary()convenience methodsviewsAdded the possibility to use aFileResourceas input for the ImageResult, GeometryResult, and PDFResult
Deprecated
viktorSupport for Python 3.10 will be removed in October 2026 (#U92)
Docs
viktorEnhanced docstrings with access patterns, plotting library compatibility, nesting restrictions, and reserved field names
v14.26.0 - 21/10/2025
Added
externalAddedget_aec_data_model_element_group_idonAutodeskFile
v14.25.0 - 17/09/2025
Added
viewsAddedAutodeskViewfor viewing Autodesk cloud storage modelsparametrizationAddedAutodeskFileFieldfor integrating with Autodesk cloud storage.
v14.24.1 - 20/08/2025
Docs
viktorInclude docstrings in stubs
Fixed
parametrizationFixed a bug that caused an emptyOptionListElementto crash the editor.viktorInit stubs missing imports of several modules fromexternal
Security
viktorUpgrade from manylinux2014 to manylinux_2_28
v14.24.0 - 29/07/2025
Added
coreAdded allow_saving to Controller.
v14.23.0 - 22/07/2025
Added
externalOAuth2Integrationto support third-party OAuth 2.0 integrations
v14.22.0 - 22/05/2025
Added
geometrySupport counter-clockwise profile forPolygonextrusionviewsAddedMapCircleobjectviewsMake private properties ofDataItempublic and make 'value' argument optionalviewsDirectly use a plotly Figure object inPlotlyResult/PlotlyAndDataResultviewsAppend items to an existing data group usingDataGroup.add()viewsAdded propertiesGeoPoint.latitudeandGeoPoint.longitudegeometrySupport hex value and RGB tuple as 'color' input on aMaterialviewsvisibleargument on views to enable view visibility based on params
v14.21.0 - 29/04/2025
Added
parametrizationinitially_expandedargument onSectionto expand or collapse individual sections on editor entryparametrization[BETA]Chatfield
v14.20.1 - 24/03/2025
Added
viktorSupport numpy v2
v14.20.0 - 05/03/2025
Added
resultDownloadResult allows file names consisting of non-ASCII characters and whitespacesparametrizationSupport OutputField in DynamicArray
Docs
api_v1Updated docstring referenceuses_privileged_apitoenable_privileged_api
Fixed
externalRcsOutputFileParser return format breaks backward compatibility in case of empty XML elementsparametrizationError in FunctionLookup during generation of OutputField causes broken editor
v14.19.0 - 08/01/2025
Known Issues
external[fixed in v14.20.0] RcsOutputFileParser return format breaks backward compatibility in case of empty XML elements
Added
coreAppoint top-level entity as starting page withInitialEntityuse_as_start_pageargument
v14.18.0 - 03/01/2025
Known Issues
external[fixed in v14.20.0] RcsOutputFileParser return format breaks backward compatibility in case of empty XML elements
Added
parametrizationSupport 'name' on DynamicArrayparametrizationRemoved [BETA] status from GeometrySelectField and GeometryMultiSelectFieldutilsIncreased expiration of memoization results from 1 hour to 24 hoursutilsIncreased amount of locally stored memoization results from 10 to 50 items
Fixed
coreRemove newly created file key from storage in case subsequent Storage.set failsparametrizationWarning regarding numeric option value within a table is not triggered for AutocompleteField and MultiSelectFieldparametrizationFixed typehint of default argument in GeometryMultiSelectField
v14.17.0 - 03/12/2024
Known Issues
external[fixed in v14.20.0] RcsOutputFileParser return format breaks backward compatibility in case of empty XML elements
Added
externalDynamoAnalysisexternalETABSAnalysisexternalMatlabAnalysisexternalPlaxisAnalysisexternalPythonAnalysisexternalRevitAnalysisexternalSAP2000AnalysisexternalTeklaAnalysis
v14.16.2 - 30/10/2024
Known Issues
external[fixed in v14.20.0] RcsOutputFileParser return format breaks backward compatibility in case of empty XML elements
Added
externalSerialized SCIA model is compressed to allow for large input models
v14.16.1 - 15/10/2024
Known Issues
external[fixed in v14.20.0] RcsOutputFileParser return format breaks backward compatibility in case of empty XML elements
Fixed
api_v1Fixed several Entity methods that did not work when using a Personal Access Token
v14.16.0 - 08/10/2024
Known Issues
external[fixed in v14.20.0] RcsOutputFileParser return format breaks backward compatibility in case of empty XML elements
Action Required
viktorRemoved support for Python 3.8
Added
viktorSupport for Python 3.13
Deprecated
viktorSupport for Python 3.9 will be removed (#U91)
Docs
viktorFixed that public classes/functions not in all were excluded from the docs
v14.15.2 - 04/09/2024
Fixed
viewsFixed TableView from pandas Styler object crashing on unsupported formatviktorRequests now use the user's system certificates to solve SSL cert verification errors
v14.15.1 - 26/08/2024
Fixed
viktorLazy import of theexternalmodules which fixes a potential ImportError and improves import speedviewsLazy import of pandas to improve import speed of theviewsmodule
v14.15.0 - 22/08/2024
Added
viktorSupport for single import (e.g.import viktor as vkt; vkt.NumberField(...))coreMake 'label' on ViktorController optionalviewsMake 'duration_guess' on all Views optional
Fixed
viewsFix bug with usingTableViewwithpandasshowing data incorrectly in certain casesviewsFix small typo inSummaryItemsuffix docstringexternalFix error mapping for spreadsheet calculation (SpreadsheetCalculation) so more error information is shownexternalFix error mapping for spreadsheet renderer (SpreadsheetTemplate / render_spreadsheet) so more error information is showncoreExternal services (e.g.convert_word_to_pdf,render_jinja_template, etc.) now show more error information
v14.14.0 - 07/08/2024
Added
utilsrender_jinja_templatenow validates identifiers before filling templateexternalrender_word_fileandWordFileTemplate.render()now validate identifiers before filling templateexternalAddedfileproperty toSpreadsheetCalculationandSpreadsheetResult
Fixed
parametrizationRemoved distracting warning when Controller contains an empty parametrizationcoreDelete temp file from disk after closing aFile.from_url
v14.13.0 - 10/07/2024
Added
viewsAddedTableViewfor easy creation of output tables
v14.12.0 - 01/07/2024
Added
api_v1Addedentity_computemethod for doing computations via the API
Fixed
externalUpdated polling interval of external integrations to make short duration external computations more responsive
v14.11.0 - 18/06/2024
Added
api_v1Added retries in relevant API callsparametrizationAdded support for disabling aStep
v14.10.1 - 17/06/2024
Fixed
viktorMark numpy v2 as incompatible with viktor
v14.10.0 - 15/05/2024
Added
parametrizationAdded GeometrySelectField and GeometryMultiSelectFieldgeometryAddedidentifierto geometrical objects
Fixed
viktorFix command to also function forapp.py
v14.9.0 - 04/04/2024
Added
api_v1AddedAPI().get_workspaceandAPI().get_workspacesapi_v1Support to use the API module from outside of a VIKTOR app
v14.8.0 - 28/02/2024
Added
parametrizationDefine dynamic option lists per dynamic array rowviewsGeometryViewx_axis_to_rightsetting to set the initial x-axis orientationexternalGrasshopperAnalysis
Deprecated
viewsGeometryViewinitial x-axis orientation will be to the right by default (#U90)
Fixed
parametrizationFix incorrect or failing serialization when using non-native objects (e.g. Color, GeoPoint, etc.) in DynamicArray default
v14.7.1 - 06/02/2024
Added
parametrizationAddedworkspace_idin signature of controller methods and callback functions
v14.7.0 - 10/01/2024
Added
viktorSupport for Python 3.12parametrizationSupport for (dynamic) visibility onPage,Tab, andSectionparametrizationSupport to specifywidthon a Page and Step to adjust the width-ratio between input and output of an editorexternalSCIA binding: general cross-sections (polygon + openings only)
Deprecated
parametrizationRemovedalways_availablefrom buttons (#U88)viktorSupport for Python 3.8 will be removed (#U89)
Fixed
viktorUpgrade vendored trimesh to resolve numpy deprecation
v14.6.1 - 16/10/2023
Added
viewsAdded the possibility to use a FileResource as input for the IFCResult and IFCAndDAtaResult
Fixed
externalDynamoconvert_geometry_to_glbcrashes due to incorrect parsing of line strips
v14.6.0 - 03/10/2023
Added
externalIDEA binding: added support to set name of design memberexternalIDEA binding: added support to set description of extremeexternalIDEA binding: added support to set project data propertiesviewsIFCView and IFCAndDataView
Fixed
geoFixed error caused by deprecated matplotlib style 'seaborn-whitegrid'viktorRemoved upper bounds of VIKTOR dependencies ('pandas' and 'munch')
v14.5.0 - 05/09/2023
Added
geometryMetalness and roughness of defaultMaterialupdated to 0.5 and 1.0 respectivelygeometryMaterialproperties can now be set on the instance (e.g.mat.opacity = 0.3)viewsSupport marker size of aMapPointby specifying thesizeargument
Deprecated
geometryThreejs properties renamed / removed fromMaterial(#U87)
v14.4.0 - 25/07/2023
Added
viewsAddgeometry_typetoGeometryResultandGeometryAndDataResultto support alternative geometry file formats (e.g. 3DM)
v14.3.0 - 11/07/2023
Added
externalSCIA binding: create averaging strips (POINT type only)parametrizationImagefield that can be used to display a static image
v14.2.1 - 15/06/2023
Fixed
api_v1Regression inlen(entity.revisions())causing an error
v14.2.0 - 13/06/2023
Added
parametrizationChildEntityManagerfield that can be used to manage child entities
v14.1.0 - 23/05/2023
Added
externalSCIA binding: create selections
v14.0.0 - 12/04/2023
Action Required
viktorUpgrade instructions U76 - U86 have been applied
Added
parametrizationColorFieldwhich allow users to select from a color palettecoreNon-breaking user messages usingUserMessagetestingAllow forParametrizationclass inmock_params
Docs
testingSimplifiedMockedEntityexample
Fixed
viktorFixedmatplotlibdependency range set too strict
v13
v13.8.0 - 16/02/2023
Added
viktorSupport for Python 3.11
v13.7.2 - 08/02/2023
Docs
viewsAdded info about "id" attribute for interaction to docstring of GeoJSONResultresultFixed example inOptimizationResultdocstring
Fixed
externalDynamoconvert_geometry_to_glbnow correctly implements transparencygeometryFixed rotation bug in Cone geometry when oriented in (0, -1, 0) direction
v13.7.1 - 16/01/2023
Fixed
errorsFixedUserErrorto accept multiple messages of any type, in line withUserException
v13.7.0 - 16/12/2022
Added
resultSupport 'Munch' type in aSetParamsResultviewsNewImageViewandImageAndDataViewthat accept 'svg', 'jpeg', 'png', 'gif' filesparametrizationValidation of aStepusing theon_nextcallback functionerrorsUserErrorto show an error to the user and mark fields invalid in the interfacecoreShow/hide top-level entities on the dashboard withInitialEntityshow_on_dashboardargument
Deprecated
viewsSVGView,JPGView,PNGVieware replaced byImageView(#U82)viewsSVGResult,JPGResult,PNGResultare replaced byImageResult(#U82)viewsSVGAndDataView,JPGAndDataView,PNGAndDataVieware replaced byImageAndDataView(#U82)viewsSVGAndDataResult,JPGAndDataResult,PNGAndDataResultare replaced byImageAndDataResult(#U82)parametrizationViolated field constraints will block actions (#U83)viktorUserExceptionwill be replaced byUserError(#U84)
v13.6.2 - 05/12/2022
Fixed
geometryRegression inCircularExtrusioncausing incorrect positioning
v13.6.1 - 17/11/2022
Fixed
viewsRegression in SVGAndDataResult causing StringIO image to crash with UnicodeEncodeError in certain cases (e.g. matplotlib)