Skip to content

api.user

All user configuration related API methods.

Example:

window.webknossos.apiReady(3).then(api => {
  api.user.getConfiguration(...);
  api.user.setConfiguration(...);
  ...
}
Methods

getConfiguration 

getConfiguration(key: keyof UserConfiguration): any

Returns the user's setting for the tracing view.

Parameters:

  • key: One of the following keys:
  • moveValue
  • moveValue3d
  • rotateValue
  • crosshairSize
  • mouseRotateValue
  • clippingDistance
  • clippingDistanceFlight
  • dynamicSpaceDirection
  • displayCrosshair
  • displayScalebars
  • scale
  • tdViewDisplayPlanes
  • tdViewDisplayDatasetBorders
  • newNodeNewTree
  • centerNewNode
  • highlightCommentedNodes
  • keyboardDelay
  • particleSize
  • overrideNodeRadius
  • sortTreesByName
  • sortCommentsAsc
  • sphericalCapRadius
  • hideTreeRemovalWarning

Example:

const keyboardDelay = api.user.getConfiguration("keyboardDelay");

setConfiguration 

setConfiguration(key: keyof UserConfiguration, value: any): void

Set the user's setting for the tracing view.

Parameters:

  • key: Same keys as for getConfiguration()

Example:

api.user.setConfiguration("keyboardDelay", 20);