Checks#

Checks allow access to the internal data structures of Production Assist using a simplified JavaScript-API and so on automate complex checks.

Multiple scripts can be created for each project. Scripts can also be created across users and used in multiple projects. The checks can be viewed in Resource Manager -> "Automatic Checks".

Editor#

The editor allows editing the code on the left and offers a list of available commands on the right. The list of commands is created dynamically. Every function requires an object as the first argument, possibly an empty object, and always returns an object, a list or undefined back.

The following functions are used particularly frequently:

Command	Arguments	Description
LR_GetObjectTree	{IncludeGeometries?: boolean, IncludeProperties?: string[]}	Returns all objects (and some of their internal data) in the current drawing as a flat, sorted list
LR_GetObject	{UUID: uuid}	Returns an object and all of the object's internal data. The UUID identifies every object in Production Assist and can be used via LR_GetObjectTree or LR_GetFirstObject be received.

In addition to the internal Production Assist functions are also available Three editor functions available:

Command	Description	Example
log	Prints a string value to the output	var t = LR_GetObjectTree({}); log(t[0].Name)
check	Checks whether the first argument true is, if not, the second argument is printed	var t = LR_GetLinkedProject({}); check(t.Project !== "", "Projekt ist nicht mit der cloud verknüpft")
analyze	Prints the contents of an object to the output. Different to log it also allows printing of objects	var t = LR_GetFirstObject({}); analyze(t)

Using Scripts#

Scripts can be incorporated into the workflow in several ways:

• They can be done manually
• You can enter calculation reports via "File" -> "Export calculation report as PDF..." using the %%SCRIPT_PROVE_CHECK(SkriptName)%% be inserted
• They can be used as an automatic check when collaborating

In all cases, the script is not only executed, but also checked for errors. In addition to JavaScript errors, this also includes all of them check-Functions whose first argument false results.

Tips and Tricks#

• Values ​​returned by Production Assist functions are always created dynamically and can change depending on the context and drawing. Data that can be found in one object can also be found in other objects. By means of the analyzefunction, an object and its data can be viewed and the structure of other objects can be deduced.
• The log-Function can only output one string at a time, but JavaScript allows numbers, objects and strings to be combined. Line breaks can be done using the control character \n be inserted. See examples
• Scripts are self-contained and do not allow access to the data of previous scripts. However, there is one exception to this for calculation reports: If several scripts are created using the %%SCRIPT_PROVE_CHECK(SkriptName)%%clause is executed, subsequent scripts can access all global data from previous scripts

Examples#

Data from Production Assist-Analyze#

var tree = LR_GetObjectTree({})

analyze(tree[0])

for(var t = 0; t < tree.length; t++){
  log(tree[t].Name)
}

Save the Current Renderer View as a View#

var obj = LR_AddNewSavedView({Name:'My new name'})
log(obj.Name)

log-Function#

var a = 1
var b = "test"

log("result: " + a + " -- " + b)

check-Function#

var tree = LR_GetObjectTree({})

var a = tree[4]
var b = tree[5]

check(a.Weight > 0, "Item " + a.Name + " has no weight! Check the Object")

analyze-Function#

var tree = LR_GetFirstObject({})

analyze(tree)

Differences from Other JavaScript Engines#

Production Assist uses a minimized JavaScript engine, which does not provide some features of the modern JavaScript. These include in particular:

• let is not available
• for(... of ...) Loops are not available
• async / await is not available
• console.log is not available

LightRight C++ → JS Bridge API reference#

Complete reference of all API functions available from the C++ core (core/jsbridge/module_main.cpp) can be exported via NAN to JavaScript.

---

Table of Contents#

1. Initialization & Lifecycle
2. File operations
3. Server synchronization
4. Object tree navigation
5. Create and delete objects
6. Object Properties & Editing
7. Selection & tree operations
8. Hierarchical operations
9. Symmetry operations
10. Geometry editing modes
11. Electrical connections
12. DMX & Fixtures
13. Presets & States
14. Worksheets
15. levels
16. classes
17. Selection groups
18. Inventory: Trucks, Cases & Racks
19. user
20. Meshes & Textures
21. Import formats
22. Export formats
23. Symbol definitions
24. Resources & Server Resources
25. Authentication & Login
26. Collaboration & Sharing
27. Templates: Cross sections
28. Templates: Materials
29. Templates: Symbol cards
30. Templates: Trucks, Cases & Racks
31. Templates: Paper & print formats
32. Templates: Property templates
33. Templates: Connectors
34. Templates: Bridle parts sets
35. Templates: Calculation & documentation reports
36. VW field mapping
37. Color codes
38. Departments
39. Load combinations & groups
40. Statics calculations & results
41. Storage & Lifting Equipment
42. Schedule & Phases
43. Notes
44. Saved Views
45. Print labels
46. Graph groups
47. Batch & Array Operations
48. Sorting operations
49. Undo/Redo
50. Clipboard operations
51. Duplicate and mirror
52. Patching & Data Patching
53. Assembly groups & sorting
54. Settings and configuration
55. Dialogues & user interface
56. Print & Export Views
57. MA3 / DMX monitoring
58. Log100 connections
59. Network & Remote Access
60. MVRxchange integration
61. Host application integration
62. Linked projects & branches
63. Custom Checks & Validation
64. Custom scripts & commands
65. Chatbot settings
66. Gels & Color Filtering
67. Property management
68. Costs and pricing
69. Digital signature
70. Tabular calculations
71. Other auxiliary functions
72. Testing & Debugging

---

1. Initialization & Lifecycle#

LR_SetEnvironment#

Initializes the application environment with paths and startup options.

Parameter	Type	Description
AppDataPath	String	Custom app data directory
GeneralAppDataPath	String	Shared app data directory
AppDir	String	Application installation directory
HomeDir	String	User home directory
StartServer	Bool	Specifies whether to start the integrated server
StartWebSockets	Bool	Specifies whether to start WebSocket connections
OnlyUseVRConnection	Bool	Use VR transport only
TestDefined	Bool	Runs in test mode
SlowTestDefined	Bool	Runs the slow test suite
DownloadDir	String	Path to the download directory

LR_ConnectCallback#

Registers JavaScript callback handlers for C++ events. Expects 5 function arguments: ChangeEvent, ShowAlert, ConsoleLog, AsyncChannel, FileOpen.

LR_MainTick#

Executes a tick of the main application loop. No parameters.

LR_Sleep#

Pauses the current thread for a specified duration.

Parameter	Type	Description
Milliseconds	Integer	Sleep time in milliseconds (default: 200)

LR_BeforeShutDownApp#

Performs shutdown preparation. Returns JSON AllowClose (Bool) back.

LR_ReloadUI#

Forces a UI reload. No parameters.

---

2. File Operations#

LR_OpenLRWFile#

Opens a LightRight project file.

Parameter	Type	Description
Path	String	File path (optional, opens file selector if empty)
Async	Bool	Specifies whether to open asynchronously

LR_OpenLRWFileFromUrl#

Downloads a project from the server and opens it.

Parameter	Type	Description
User	String	Server username
Project	String	Projektkennung
Branch	String	Branch name
SigningJob	String	Signing job ID (optional)
Async	Bool	Specifies whether to open asynchronously

LR_OpenLRWFolder#

Opens a folder-based project with session tracking.

Parameter	Type	Description
Path	String	Ordnerpfad
FileID	String	Dateikennung
SessionID	String	Session tracking ID
Async	Bool	Specifies whether to open asynchronously

LR_CloseLRWFile#

Closes a drawing file.

Parameter	Type	Description
Path	String	File path (optional)
SessionID	String	Session to be cleaned up

LR_SaveFile#

Saves the drawing to disk.

Parameter	Type	Description
Path	String	Save path (optional, uses current path or opens dialog)
SaveAs	Bool	Forces the Save As dialog

LR_SaveSceneJson#

Saves the drawing as a raw JSON scene file.

Parameter	Type	Description
Path	String	Output file path

LR_DisableAutosaveTimer#

Enables or disables autosave.

Parameter	Type	Description
DisableAutosaveTimer	Bool	true to disable

LR_GetCurrentDrawingPath#

Returns the file path of the active drawing. Returns JSON.

LR_GetDrawings#

Returns a list of all open drawings with the UUID of the active drawing. Returns JSON.

LR_DrawingPathExist#

Checks whether a drawing with the specified path is already open. Returns JSON (Bool).

LR_SetActiveDrawing#

Switches to a specified drawing or removes a server copy.

Parameter	Type	Description
DrawingUUID	UUID	Drawing to activate (optional)
DeleteServerDrawing	Bool	Specifies whether to remove the server copy

LR_CreateNewDrawing#

Creates a new blank drawing. No parameters.

LR_GetAvailableWebsocketPorts#

Reads available WebSocket ports from the configuration. Returns a JSON array.

---

3. Server Synchronization#

LR_CheckoutProject#

Downloads a project from the server and opens it as a new drawing.

Parameter	Type	Description
Project	String	Projektkennung
User	String	Server username
Branch	String	Branch name
BranchName	String	Branch display name

LR_CommitToServer#

Transfers current drawing changes to the server. If there are conflicts, a diff dialog is displayed. No parameters. Asynchronous.

LR_CommitApprovedChanges#

Completes a server commit after conflict resolution.

Parameter	Type	Description
Differences	JSON	Approved changes from the diff dialog
Message	String	Commit message

LR_CommitRessourceDrawing#

Transfers a resource drawing to the server. No parameters. Asynchronous.

LR_CommitRessourceDrawingApprovedChanges#

Completes the commit of a resource drawing after conflict resolution.

Parameter	Type	Description
Differences	JSON	Approved changes
Message	String	Commit message

LR_UpdateFromServer#

Retrieves the latest changes from the server and displays the diff dialog. No parameters. Asynchronous.

LR_UpdateApprovedChanges#

Applies approved changes from a server update to the active drawing. Expects the diff data as an input object.

LR_CheckoutRessourceDrawing#

Downloads a resource drawing from the server and opens it.

Parameter	Type	Description
Identifier	String	Resource identifier
RevisionId	String	Revision ID
User	String	Server username

LR_CompareToActiveDrawing#

Compares a drawing file with the active drawing.

Parameter	Type	Description
UUID	UUID	Drawing to compare

LR_CompareTwoServerDrawings#

Compares two server-side drawings.

Parameter	Type	Description
Folder	String	Projektordner
Base	String	Basic revision
Target	String	Target revision

LR_MergeTwoServerDrawings#

Merges two server-side branches.

Parameter	Type	Description
Folder	String	Projektordner
Base	String	Base branch
Target	String	Target branch
Option	Object	Merge options (CopyResources, UpdateObjects)
BaseOnly	Array	Elements only in the base
TargetOnly	Array	Elements only in the target

LR_MergeTwoServerDrawingsTemplate#

Merges two server drawings using template matching.

Parameter	Type	Description
FolderBase	String	Basisordner
FolderTarget	String	Target folder
Base	String	Basiskennung
Target	String	Zielkennung

LR_ApplyDiff#

Applies a diff to the drawing.

Parameter	Type	Description
ApplyTo	UUID	Zielzeichnung
ApplyFrom	UUID	Quellzeichnung
Diff	Object	Diff data

LR_UpdateFromBranch#

Synchronized from a server branch.

Parameter	Type	Description
Branch	String	Branch name

LR_UpdateFromTemplate#

Updates the drawing based on a linked template. No parameters.

LR_CreateBranchAsync#

Asynchronously creates a new project branch.

Parameter	Type	Description
Name	String	Branch name

LR_DeleteGroupOnServer#

Removes a group on the server.

Parameter	Type	Description
Folder	String	Projektordner
GroupName	String	Group name
File	String	Dateikennung

---

4. Object Tree Navigation#

LR_GetFirstObject#

Returns the root object of the scene. Returns JSON.

LR_GetFirstChild#

Returns the first child of an object.

Parameter	Type	Description
UUID	UUID	Parent object

LR_GetNextObject#

Returns the closest sibling of an object.

Parameter	Type	Description
UUID	UUID	Current object

LR_GetObjectTree#

Gets the hierarchical object tree with optional properties and geometry. Asynchronous.

Parameter	Type	Description
FirstUUID	UUID	Root UUID (optional)
CompleteTree	Bool	Include full subtree
IncludeGeometries	Bool	Include geometry data
ForceObjectTree	Bool	Force tree structure
IncludeProperties	Array	Property names to include
IncludeGeometryProperties	Array	Geometry property names to include
ResolveContainer	Bool	Explode container objects
UseSorting	Bool	Enable sorting
OrderReversed	Bool	Reverse sort order

LR_GetGeometryTree#

Gets the geometry hierarchy for a container. Asynchronous.

Parameter	Type	Description
ObjectUUID	UUID	Root container UUID
ResolveContainer	Bool	Explode container objects

LR_GetCompleteObject#

Returns complete object data using the UUID.

Parameter	Type	Description
UUID	UUID	Object to retrieve

LR_GetSelectiveObject#

Returns an object with only selected properties. Asynchronous.

Parameter	Type	Description
UUID	UUID	Object to retrieve
IncludeProperties	Array	Property names to include

LR_GetCompleteFirstObject#

Returns complete data for the root object. No parameters. Returns JSON.

LR_GetCompleteFirstChild#

Returns full data for the first child object.

Parameter	Type	Description
UUID	UUID	Parent object

LR_GetCompleteNextObject#

Returns full data for the next sibling element.

Parameter	Type	Description
UUID	UUID	Current object

---

5. Object Creation & Deletion#

LR_AddNewObject#

Creates a new drawing object with full transformation control.

Parameter	Type	Description
NoReturnValue	Bool	Skip return value for performance reasons
ResourceType	Integer	Resource type to create
magnetUUID	UUID	Magnet snap target (optional)
ResourceContainerUUID	UUID	Resource container reference
UUID	UUID	Predefined UUID (optional)
ParentUUID	UUID	Parent object
Px, Py, Pz	Double	Position X, Y, Z
P2x, P2y, P2z	Double	Viewpoint X, Y, Z
Qx, Qy, Qz, Qw	Double	Orientation quaternion
Sx, Sy, Sz	Double	Scaling X, Y, Z
Matrix	Matrix4x4	Full transformation matrix (optional)
offsetMagnet	Bool	Apply magnetic offset
SnappedPoints	Array	Snap data

LR_AddNewObject_Line#

Creates an array of objects along a line between two points.

Parameter	Type	Description
ResourceType	Integer	Resource type
Px1, Py1, Pz1	Double	Startposition
Px2, Py2, Pz2	Double	Endposition
Qx1, Qy1, Qz1, Qw1	Double	Start orientation quaternion
Qx2, Qy2, Qz2, Qw2	Double	End orientation quaternion
DistanceBetweenObjects	Double	Distance between objects
ExtrusionHeight	Double	Extrusion height

LR_AddObjectArray#

Creates objects from a typed array definition.

Parameter	Type	Description
Type	Integer	Array type
Props	Object	Array properties

LR_SetObjectArray#

Updates an existing object array.

Parameter	Type	Description
Type	Integer	Array type
Props	Object	Updated properties

LR_DeleteObject#

Deletes a single object.

Parameter	Type	Description
UUID	UUID	Object to delete
IfSelectedAllSelected	Bool	Delete all selected when target is selected

LR_DeleteSelectedObjects#

Deletes all currently selected objects. No parameters.

LR_DeleteObjects#

Deletes multiple objects using a UUID list.

Parameter	Type	Description
UUIDList	Array	UUIDs to delete

---

6. Object Properties & Editing#

LR_GetObject#

Returns basic object information using the UUID.

Parameter	Type	Description
UUID	UUID	Object to retrieve

LR_SetObject#

Updates values in the Object Properties as well as position, rotation and scale.

Parameter	Type	Description
UUID	UUID	Object to update
UseDefault	Bool	Apply default values
Preset	UUID	Preset to apply (optional)
Use_quaternion_and_pos	Bool	Use position/quaternion transformations
Px, Py, Pz	Double	Position X, Y, Z
Qx, Qy, Qz, Qw	Double	Orientation quaternion
Matrix	Matrix4x4	Full matrix (optional)
P2x, P2y, P2z	Double	Blickpunkt
Sx, Sy, Sz	Double	Scaling X, Y, Z
RotByDirStartX/Y/Z	Double	Direction of rotation start
RotByDirEndX/Y/Z	Double	Direction of rotation end
RotByDirUpX/Y/Z	Double	Rotation Up Vector

LR_SetMultipleObjects#

Batch updates properties of multiple objects. Expects an array of objects, each with UUID, UseDefault and Preset.

LR_GetObjectProperties#

Retrieves detailed properties of an object. Asynchronous.

Parameter	Type	Description
UUID	UUID	Object (optional, uses selection)
CalcResults	Bool	Include calculation results

LR_SetObjectProperties#

Sets Object Properties with mode control.

Parameter	Type	Description
PropertySettingMode	Integer	Einstellungsmodus
ApplyToChildObject	Bool	Apply to child objects

LR_SetAlignedValue#

Sets an aligned/distributed property value across multiple objects.

Parameter	Type	Description
type	Integer	Ausrichtungstyp
Property	String	Property name
value1	JSON	Startwert
value2	JSON	Endwert
Preset	UUID	Preset reference (optional)

LR_GetPropertyValue#

Gets a single property value. Asynchronous.

Parameter	Type	Description
UUID	UUID	Object
PropertyName	String	Property identifier
ArrayName	String	Array property name (optional)
ArrayPosition	Integer	Array index (optional)
IncludeUnit	Bool	Include unit in result

LR_SetWeightForObject#

Sets the weight for objects.

Parameter	Type	Description
Objects	Array	Object UUIDs
Weight	Double	Gewichtswert
SetForAll	Bool	Apply to everyone

LR_MoveObjectToPoint#

Moves objects to specific coordinates.

Parameter	Type	Description
Objects	Array	Object UUIDs
Payload	String	Zielkennung
X, Y, Z	Double	Zielkoordinaten
MoveLoadPoint	Bool	Move load point

LR_GetCalcResults#

Returns current calculation results. No parameters. Returns JSON.

---

7. Selection & Tree Operations#

LR_Select#

Selects objects with full mode control.

Parameter	Type	Description
SelectionMode	Integer	Auswahlmodus
SelectionGroupMode	Integer	Groupnauswahlmodus
SelectedList	Array	UUID list
PropertyName	String	Property for selection
ArrayName	String	Array property name
ShiftKey	Bool	Shift modifier
MetaKey	Bool	Meta/cmd modifier
AltKey	Bool	Alt modifier
Selected	Bool	Select/Deselect
UseDrawingOrder	Bool	Pay attention to the order of characters
ZoomToSelection	Bool	Automatically zoom to selection

LR_SelectAll#

Selects or deselects all objects.

Parameter	Type	Description
Value	Bool	true to select all, false to deselect

LR_SelectChildren#

Selects all children of an object.

Parameter	Type	Description
UUID	UUID	Parent object

LR_CollapseChildren#

Collapses child objects in the tree view.

Parameter	Type	Description
UUID	UUID	Parent object

LR_SelectNext / LR_SelectPrev / LR_SelectUp / LR_SelectDown#

Navigates and selects in the tree.

Parameter	Type	Description
SelectAddition	Bool	Add to selection

LR_ExpandAll#

Expands or collapses all tree nodes.

Parameter	Type	Description
Value	Bool	true to expand, false to collapse

LR_GetSelectedObjects#

Returns an array of UUIDs of selected objects.

Parameter	Type	Description
IncludeGeometries	Bool	Include geometry objects

LR_GetSelectedObjectCount#

Returns the number of selected objects. Returns JSON (Integer).

LR_MoveSelectedUp / LR_MoveSelectedDown#

Moves selected objects up/down in the tree. No parameters.

---

8. Hierarchical Operations#

LR_SetChild#

Makes one object the child of another.

Parameter	Type	Description
ParentUUID	UUID	New parent object
ChildUUID	UUID	Object to be reassigned
GlobalCoordinates	Bool	Maintain global position

LR_SetNext#

Sets the sibling relationship to the subsequent element.

Parameter	Type	Description
PrevUUID	UUID	Previous sibling element
NextUUID	UUID	Next sibling element
GlobalCoordinates	Bool	Maintain global position

LR_SetPrev#

Sets the sibling relationship to the previous element.

Parameter	Type	Description
PrevUUID	UUID	Previous sibling element
NextUUID	UUID	Current object
GlobalCoordinates	Bool	Maintain global position

LR_GroupSelected#

Creates a group from the current selection.

Parameter	Type	Description
Name	String	Group name

LR_DisolveGroup#

Dissolves objects from a group.

Parameter	Type	Description
UUID	UUID	Group to be disbanded

---

9. Geometry Operations#

LR_GetFirstChildGeometry / LR_GetNextGeometry / LR_GetGeometry#

Returns geometry objects using the UUID. Each function expects a UUID parameter.

LR_GetGeometryTransformFromObject#

Returns the transformation of a geometry relative to its parent object.

Parameter	Type	Description
Object	UUID	Parent object
Geometry	UUID	Geometrieobjekt

LR_SetGeometry#

Updates a geometry object.

Parameter	Type	Description
UUID	UUID	Geometry to update
Preset	UUID	Presets (optional)
UseDefault	Bool	Apply default values

LR_SetGeometryDefiningResource#

Associates a geometry with a resource definition.

Parameter	Type	Description
ObjectUUID	UUID	Object
GeometryUUID	UUID	Geometry

LR_AddNewStructureGeometry#

Creates a truss structure geometry between two points.

Parameter	Type	Description
ParentUUID	UUID	Parent object
From, from, from	Double	Startpunkt
ToX, ToY, ToZ	Double	Endpunkt
Rotation	Double	Rotationswinkel
CrossSection	String	Querschnittsname
R, G, B	Double	Color (0.0–1.0)
UseAsInternalStructure	Bool	Mark as internal structure
Name	String	Name

LR_AddNewSupportGeometry#

Creates a bearing/hoist geometry.

Parameter	Type	Description
ParentUUID	UUID	Parent object
From, from, from	Double	Startpunkt
ToX, ToY, ToZ	Double	Endpunkt
CrossSection	String	Querschnittsname

LR_AddNewPolygonGeometry#

Creates a polygon geometry.

Parameter	Type	Description
ParentUUID	UUID	Parent object
ObjectPath	Array	Pfadpunkte
Name	String	Polygonname
Closed	Bool	Closed path
Filled	Bool	Filled polygon

LR_SetDefiningResourceGeometry#

Updates the defining resource of a geometry.

Parameter	Type	Description
ObjectUUID	UUID	Object
GeometryUUID	UUID	Geometry

LR_GetCrossSectionByColor#

Gets a cross section associated with a color.

Parameter	Type	Description
CrossSectionBaseName	String	Basisname
R, G, B	Double	Farbwerte

---

10. Geometry Editing Modes#

LR_OpenGeometryEditMode#

Opens the geometry editor.

Parameter	Type	Description
UUID	UUID	Object to edit
Selected	Bool	Use selected objects
Object	Bool	Edit geometry at the object level

LR_CloseGeometryEditMode#

Closes the geometry editor.

Parameter	Type	Description
KeepChanges	Bool	Save changes on exit

LR_GetGeometryEditMode#

Returns the current edit mode state. Returns JSON.

LR_OpenPolygonRendererViewEditMode#

Opens the Polygon Renderer Editor.

Parameter	Type	Description
UUID	UUID	Object to edit

LR_ClosePolygonRendererViewEditMode#

Closes the Polygon Renderer Editor.

Parameter	Type	Description
RendererViewSavedView	Object	View state to restore

LR_GetPolygonRendererViewEditMode#

Returns the edit mode state of the polygon renderer. Returns JSON.

---

11. Electrical Connections#

LR_AddElectricalConnection#

Creates electrical connections at the connector level. Expects an array or a single object with from/to connection details.

LR_RemoveElectricalConnection#

Removes electrical connections at the connector level. Expects an array or a single object with from/to information.

LR_ClearElectricalConnection#

Deletes all connections on a specified port.

Parameter	Type	Description
Objects	Array	Object UUIDs
Socket	Integer	Connection index

LR_AddElectricalObjectConnection#

Connects two electrical objects via cables. Expects an array or a single object with from/to object/line details.

LR_RemoveElectricalObjectConnection#

Removes electrical object connections. Expects an array or a single connection specification.

LR_AddAndRemoveElectricalObjectConnection#

Add and remove electrical connections in batches.

Parameter	Type	Description
Add	Array	Connections to add
Remove	Array	Connections to remove

LR_ResolveMultipleOutputUsage#

Resolves multiple output connections on a connector.

Parameter	Type	Description
ConnectorSelection	Object	Connector info
ObjectList	Array	Object UUIDs

LR_SetUsedCables#

Sets selected cables for a connector.

Parameter	Type	Description
Geometry	UUID	Geometriereferenz
SelectedCables	Array	Cable UUIDs

LR_SetCableColor#

Sets the color of a cable.

Parameter	Type	Description
UUID	UUID	Cable-UUID
CieColor	String	CIE color value
portName	String	Port name

LR_GetElectricalObjects#

Returns circuit-connected objects. Asynchronous.

Parameter	Type	Description
IncludeProperties	Array	Property names to include
CompleteTree	Bool	Include full tree

LR_GetElectricalGeometries#

Returns 2D electrical plan geometries. Asynchronous.

Parameter	Type	Description
UUIDs	Array	Object UUIDs to query

LR_GetCurrentElectricalTree#

Returns the DMX tree with conflict information. Returns JSON.

LR_GetCurrentSimpleElectricalTree#

Returns a simplified electrical tree. Returns JSON.

LR_ReRunElectricalCalculation#

Recalculates the electrical routing. No parameters.

---

12. DMX & Fixtures#

LR_GetFixtureTypes#

Lists all available fixture types. Returns JSON.

LR_GetFixtureTypesFromObject#

Returns the fixture type for a given object.

Parameter	Type	Description
UUID	UUID	Object

LR_SetFixtureTypes#

Assigns fixture types.

Parameter	Type	Description
FixtureTypes	Array	Fixture type assignments

LR_NumberAllFixtures#

Automatically numbers fixtures starting from a reference object.

Parameter	Type	Description
UUID	UUID	Startobjekt

LR_AddNewDmxMode#

Adds a DMX mode to a fixture type.

Parameter	Type	Description
UUID	UUID	Fixture type
Name	String	Modusname
DMX FootPrint 1-4	Integer	DMX channel footprints

LR_SetDefaultFixtureType#

Sets the default fixture type.

Parameter	Type	Description
UUID	UUID	Fixture type

LR_GetLastFixtureTypes#

Returns recently used fixture types. Returns JSON.

LR_GetDmxTree#

Returns the DMX universe structure. Returns JSON.

LR_ReplaceSelectedFixtureTypes#

Replaces fixture types on selected objects. No parameters.

LR_GetDuplicatedFixtureIDs#

Searches for duplicate fixture IDs in the drawing. Returns JSON.

LR_GetDuplicatedObjectIds#

Searches for duplicate object IDs. Returns JSON.

---

13. Presets & States#

LR_AddNewPreset#

Creates a new preset from the current object state. Returns JSON.

LR_DeletePreset#

Removes a preset. Accepts UUID.

LR_GetPresets#

Lists all presets. Returns JSON.

LR_SetPreset#

Updates preset properties. Expects UUID and property data.

LR_SetEditablePreset#

Marks a preset as editable. Returns JSON.

Parameter	Type	Description
UUID	UUID	Preset

LR_SetActivePreset#

Enables or disables a preset.

Parameter	Type	Description
UUID	UUID	Preset
Active	Bool	Active state

LR_SetPresetOrder#

Changes the order of the presets. Expects an array of UUIDs.

LR_DeactivatePresets#

Disables all presets. No parameters.

LR_RemovePresetEntry#

Removes an entry from a preset.

Parameter	Type	Description
PresetUUID	UUID	Preset
PropertyName	String	Property to remove
Objects	Array	Affected objects

LR_GetPresetContent#

Returns the contents of a preset.

Parameter	Type	Description
UUID	UUID	Preset

LR_GetAllPresetsContent#

Returns the contents of all presets. Returns JSON.

LR_GetAllActiveFixtures#

Returns all active fixture objects. Returns JSON.

LR_GetFixturesByAlignment#

Returns fixtures grouped by orientation. Returns JSON.

---

14. Worksheets#

LR_AddNewWorksheet#

Creates a new worksheet.

Parameter	Type	Description
ObjectUUIDs	Array	Object UUIDs to include (optional)
ObjectUUID	UUID	Single object (optional)
LayerUUID	UUID	Filter by level (optional)
ClassUUID	UUID	Filter by class (optional)
AppendName	String	Append to worksheet name

LR_DeleteWorksheet#

Deletes a worksheet.

Parameter	Type	Description
UUID	UUID	Worksheet (optional, individual)
UUIDS	Array	Multiple worksheets (optional)

LR_GetWorksheets#

Lists all worksheets. Returns JSON.

LR_GetWorksheetObjects#

Returns objects on a worksheet. Asynchronous.

Parameter	Type	Description
UUID	UUID	Worksheet
ResolveContainer	Bool	Dissolve containers
IncludeGeometries	Bool	Include geometries

LR_SetWorksheet#

Updates worksheet properties.

Parameter	Type	Description
UUID	UUID	Worksheet
Worksheets	Array	Updated data (optional)

LR_SetWorksheetOrder#

Changes the order of the worksheets. Expects an array of UUIDs.

LR_GetWorksheetActivePresets#

Returns active presets for a worksheet.

Parameter	Type	Description
UUID	UUID	Worksheet

LR_DuplicateWorksheet#

Clones a worksheet.

Parameter	Type	Description
UUID	UUID	Worksheet to duplicate

LR_CreateAssemblySheetsForGroups#

Automatically creates assembly worksheets from groups. Expects the object data.

LR_ShowWorkSheet#

Displays a worksheet in the user interface.

Parameter	Type	Description
UUID	UUID	Worksheet

LR_GetForcedWorksheet#

Returns the UUID of the mandatory worksheet. Returns JSON.

LR_WorksheetFilterHelper#

Filters objects for a worksheet. Asynchronous.

Parameter	Type	Description
WorksheetUUID	UUID	Worksheet
UuidToFilter	Array	UUIDs to check
WorksheetViewType	Integer	ViewType

---

15. Layers#

LR_AddNewLayer#

Creates a new layer from the input object. Returns JSON.

LR_DeleteLayer#

Deletes a layer. Accepts UUID.

LR_DeleteLayers#

Deletes multiple layers. Expects UUIDList (array).

LR_GetLayer#

Returns layer information. Accepts UUID. Returns JSON.

LR_GetLayers#

Lists all levels. Returns JSON.

LR_SetLayer#

Updates a layer.

Parameter	Type	Description
ModifierKey	Bool	Modify key pressed
UUID	UUID	Layer

LR_SetLayers#

Updates layers in batches.

Parameter	Type	Description
LayerObjects	Array	Layer data objects

LR_GetActiveLayer#

Returns the currently active layer. Returns JSON.

LR_SetActiveLayer#

Sets the active layer.

Parameter	Type	Description
Layer	UUID	Layer to activate

---

16. Classes#

LR_AddNewClass#

Creates a new class from the input object. Returns JSON.

LR_DeleteClass#

Deletes a class. Accepts UUID.

LR_DeleteClasses#

Deletes multiple classes. Expects UUIDList (array).

LR_GetClass#

Returns class information. Accepts UUID. Returns JSON.

LR_GetClasses#

Lists all classes. Returns JSON.

LR_SetClass#

Updates a class.

Parameter	Type	Description
ModifierKey	Bool	Modify key pressed
UUID	UUID	Class

LR_SetClasses#

Updates classes in batches.

Parameter	Type	Description
ClassObjects	Array	Class data objects

LR_GetActiveClass#

Returns the currently active class. Returns JSON.

LR_SetActiveClass#

Sets the active class.

Parameter	Type	Description
Class	UUID	Class to activate

---

17. Selection Groups#

LR_AddSelectionGroupForFixturesInLine#

Creates a selection group of fixtures along a line.

Parameter	Type	Description
Selected	Bool	Use selected objects

LR_AddNewSelectionGroup#

Creates a new selection group.

Parameter	Type	Description
PushSelected	Bool	Add selected objects to the group

LR_DeleteSelectionGroup#

Deletes a selection group. Accepts UUID.

LR_GetSelectionGroups#

Lists all selection groups. Returns JSON.

LR_AddObjectToSelectionGroup#

Adds an object to a group.

Parameter	Type	Description
Group	UUID	Auswahlgruppe
Object	UUID	Object to add

LR_SetSelectionGroup#

Updates a selection group. Accepts UUID.

---

18. Inventory: Trucks, Cases & Racks#

LR_AddNewTruck / LR_DeleteTruck / LR_GetTrucks / LR_GetTruck / LR_SetTruck#

CRUD operations for trucks. Add/Get returns JSON. Delete/Set expects UUID.

LR_GetTruckObjects#

Returns objects assigned to a truck. Asynchronous. Accepts UUID.

LR_AddNewCase#

Creates a new case.

Parameter	Type	Description
amountToAdd	Integer	Number of cases to be created

LR_GetCases / LR_SetCase / LR_DeleteCase#

CRUD for cases. Accepts UUID for Set/Delete.

LR_AddNewRack#

Creates a new rack.

Parameter	Type	Description
RackTemplate	String	Vorlagenname

LR_GetRacks / LR_SetRack / LR_DeleteRack#

CRUD for racks. Accepts UUID for Set/Delete.

LR_GetInventoryData#

Returns inventory data (grouped). Asynchronous.

Parameter	Type	Description
FirstUUID	UUID	Root object
WorksheetState	Object	Worksheet configuration
UseGrouping	Bool	Enable grouping

LR_GetInventorySummery#

Returns an inventory summary. Asynchronous. No parameters.

LR_GetInventoryContainerOptions#

Returns UI options for inventory containers. Returns JSON.

LR_GetTableViewGroupingData#

Returns grouped table view data. Asynchronous.

Parameter	Type	Description
FirstUUID	UUID	Root object
WorksheetState	Object	Configuration
UseGrouping	Bool	Enable grouping

LR_PackObjectsIntoContainer#

Automatically packs objects into inventory containers.

Parameter	Type	Description
Container	Array	Container data
Template	String	Vorlagenname
TemplateType	Integer	Vorlagentyp

---

19. Users#

LR_AddNewUser#

Adds a user to the project. Returns JSON.

LR_GetUsers#

Lists project users. Returns JSON.

LR_SetUser#

Updates a user. Accepts UUID.

LR_DeleteUser#

Removes a user. Accepts UUID.

---

20. Meshes & Textures#

LR_GetMeshes#

Lists all meshes.

Parameter	Type	Description
WithCount	Bool	Include usage counters

LR_GetMesh#

Returns mesh data. Accepts UUID.

LR_GetMeshesForResources#

Returns meshes for resource references.

Parameter	Type	Description
ResourceUUID	UUID	Ressource
ResourceType	Integer	Resource type

LR_SetMesh#

Updates a mesh. Accepts UUID.

LR_SetDefaultMesh#

Sets a mesh as the default. Accepts UUID. Returns JSON.

LR_GetTextures#

Lists all textures. Asynchronous. Returns JSON.

LR_GetSingleTexture#

Returns texture data. Asynchronous.

Parameter	Type	Description
UUID	UUID	Textur
Name	String	Texturname

LR_GetExternalDocuments#

Lists external documents. Returns JSON.

LR_DeleteExternalDocument#

Removes an external document. Accepts UUID.

LR_SetPreviewTextures#

Sets textures for preview mode.

Parameter	Type	Description
Textures	Array	Texturdaten

LR_GetPreviewTextures#

Returns preview textures.

Parameter	Type	Description
WriteBuffer	Bool	Include buffer data

LR_GetPreviewTextureFromObject#

Gets the preview texture of an object.

Parameter	Type	Description
Object	UUID	Objekt
WriteBuffer	Bool	Include buffer data

LR_DeleteTexture#

Deletes a texture. Accepts UUID.

---

21. Import Formats#

LR_ReadIFC#

Imports an IFC building model. Asynchronous.

Parameter	Type	Description
Path	String	File path (optional, opens file selection)

LR_ReadSketchUp#

Imports a SketchUp file. Asynchronous.

Parameter	Type	Description
Path	String	File path (optional)

LR_ReadDWG#

Imports an AutoCAD DWG/DXF file.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode
Scale	Double	Scaling factor
Center	Bool	Center in the drawing

LR_ReadMVR#

Imports an MVR file.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode
SymbolMap	Bool	Apply symbol mapping
ImportGroups	Bool	Import group structure

LR_ReadPDF#

Imports a PDF file. Asynchronous.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode

LR_ReadMa3Cue#

Imports a MA3 Cue XML file.

Parameter	Type	Description
Path	String	File path (optional)

LR_ImportGdtf#

Imports a GDTF device type file.

Parameter	Type	Description
Path	String	File path (optional)
Last	Bool	Use last import path

LR_ImportMesh#

Imports a 3D mesh file.

Parameter	Type	Description
Path	String	File path (optional)

LR_ImportMeshScene#

Imports a 3D mesh scene.

Parameter	Type	Description
Path	String	File path
BackFile	String	Hintergrunddatei

LR_ImportTexture#

Imports a texture image.

Parameter	Type	Description
Path	String	File path (optional)
Last	Bool	Use last import path

LR_ImportExternalDocument#

Imports an external document.

Parameter	Type	Description
Path	String	File path (optional)

LR_ImportSVG#

Imports an SVG graphic. Asynchronous.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode

LR_ImportLRWX#

Imports a LightRight export file.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode
Checkout	Bool	Check out from server
Project	String	Project (at checkout)
User	String	User (at checkout)
Branch	String	Branch (at checkout)
BranchName	String	Branch display name

LR_ImportDSTV#

Imports a DSTV file.

Parameter	Type	Description
Path	String	File path (optional)
Async	Bool	Asynchronous mode

LR_ImportTradeShowLoadExchange#

Imports a trade show load exchange file.

Parameter	Type	Description
Path	String	File path
Data	Object	Importdaten
DataArray	Array	Import data array

LR_ImportPrintLabel#

Imports a print label file.

Parameter	Type	Description
File	String	File path
UUID	UUID	Designation-UUID

LR_Import#

General import function.

Parameter	Type	Description
Path	String	File path (optional)
Type	String	Importtyp

LR_ReadVectorworksDrawing#

Reads a Vectorworks drawing. No parameters.

---

22. Export Formats#

LR_WriteMVR#

Exports the drawing to an MVR file.

Parameter	Type	Description
Path	String	Output path (optional, opens file selection)

LR_WriteCrossSection#

Exports a truss cross section as JSON.

Parameter	Type	Description
Path	String	Output path (optional)
PayLoad	Object	Querschnittsdaten

LR_ExportAsGdtf#

Exported as GDTF device type.

Parameter	Type	Description
Path	String	Output path (optional)

LR_ExportDSTV#

Exported in DSTV format.

Parameter	Type	Description
Path	String	Output path (optional)

LR_ExportIFC#

Exported in IFC building model format.

Parameter	Type	Description
Path	String	Output path (optional)

LR_ExportTradeShowLoadExchange#

Exports trade show load exchange data.

Parameter	Type	Description
Path	String	Ausgabepfad
TradeShowName	String	Name of the fair
Hall	String	Hallenbezeichnung
Booth	String	Standbezeichnung
Company	String	Firmenname

LR_ExportSymbols#

Exports the symbol library.

Parameter	Type	Description
Symbols	Array	Symbol-UUIDs
ResourceType	Integer	Resource type (optional)
Path	String	Output path (optional)

LR_ExportPolygon#

Exports a polygon as a mesh.

Parameter	Type	Description
Polygon	UUID	Polygon-UUID
Path	String	Output path (optional)

LR_ExportMeshScene#

Exports a 3D mesh scene.

Parameter	Type	Description
Path	String	Output path (optional)
Type	String	Exporttyp

LR_Export#

General export function.

Parameter	Type	Description
Path	String	Output path (optional)
Type	String	Exporttyp

LR_WritePngToDisk#

Saves a PNG image to disk.

Parameter	Type	Description
Path	String	Output path (optional)
Base64	String	Base64 encoded image data

LR_WriteSvgToDisk#

Saves an SVG image to disk.

Parameter	Type	Description
Path	String	Output path (optional)
SVG	String	SVG markup

---

23. Symbol Definitions#

LR_GetSymbolDefs#

Lists all symbol definitions. Returns JSON.

LR_AddNewSymbolDefinition#

Creates a new symbol definition.

Parameter	Type	Description
UUID	UUID	Predefined UUID (optional)
CopySelected	Bool	Copy from selected objects

LR_SetSymbolDef#

Updates a symbol definition. Accepts UUID.

LR_SetDefaultSymbolDef#

Sets the default symbol definition. Accepts UUID. Returns JSON.

LR_GetLastUsedSymbolDefs#

Returns recently used symbol definitions. Returns JSON.

LR_DeleteSymbolContent#

Deletes all geometry from a symbol definition. Accepts UUID.

LR_ReplaceSelectedSymbolDefinition#

Replaces the symbol definition on selected objects. No parameters.

LR_GenerateNewSymbolUuids#

Regenerates UUIDs for symbols. No parameters.

---

24. Resources & Server Resources#

LR_GetRessourceDrawing#

Loads a resource drawing file.

Parameter	Type	Description
File	String	Path to the resource file

LR_ImportRessource#

Imports a resource.

Parameter	Type	Description
File	String	File path
UUID	UUID	Resource-UUID

LR_ImportFixtureType#

Imports a device type definition.

Parameter	Type	Description
File	String	File path
UUID	UUID	Device type-UUID

LR_GetServerResource#

Downloads a resource from the server. Returns JSON.

LR_GetServerResourceCached#

Gets a cached server resource. Returns JSON.

LR_GetServerResourceAsync#

Asynchronously downloads a resource from the server.

Parameter	Type	Description
Minified	Bool	Use compressed version

LR_GetUserResource / LR_GetUserResourceAsync#

Retrieves user-specific resources.

Parameter	Type	Description
User	String	User name

LR_ImportServerResourceAsync#

Imports a resource from the server. Asynchronous.

Parameter	Type	Description
User	String	User name
Identifier	String	Resource identifier
UUID	UUID	Resource-UUID
ResourceType	Integer	Resource type
RevisionId	String	Revision ID

LR_CacheServerResourceAsync#

Locally caches a server resource. Asynchronous.

Parameter	Type	Description
User	String	User name
Identifier	String	Resource identifier
RevisionId	String	Revision ID

LR_CreateResourceCategoryOnServer#

Creates a resource category on the server.

Parameter	Type	Description
Category	String	Kategoriename
Username	String	User name
ParentCategory	String	Parent category

LR_UploadSingleResourceToServerAsync#

Uploads a single resource to the server. Asynchronous.

Parameter	Type	Description
UUID	UUID	Resource-UUID
Username	String	User name
Category	String	Kategorie
Filename	String	Dateiname
Manufacturer	String	Hersteller
Description	String	Description
Overwrite	String	Overwrite mode
OverwriteIdent	String	Override identifier

LR_DownloadAllResource#

Downloads all resources from the server. Asynchronous. No parameters.

LR_GetLocaleResources#

Downloads localization resources. Asynchronous. Returns JSON.

LR_GetLocaleResourcesCached#

Retrieves cached localization resources. Returns JSON.

LR_GetCachedResources#

Lists all cached resources. Returns JSON (BasePath, Files).

LR_DuplicateResource#

Duplicates a resource.

Parameter	Type	Description
UUID	UUID	Ressource
ResourceType	Integer	Type

LR_DeleteResource#

Deletes a resource.

Parameter	Type	Description
ResourceType	Integer	Type
UUID	UUID	Ressource

LR_DeleteUnusedObjects#

Cleans up unused objects from the drawing. No parameters.

LR_GetActiveResource#

Returns the active resource for a given type.

Parameter	Type	Description
ResourceType	Integer	Type

LR_NAN_DownloadResource#

Downloads a resource by ID (NAN_METHOD, not LR_JS_API_METHOD).

Parameter	Type	Description
RessourceID	String	Resource ID

LR_NAN_DownloadRevision#

Downloads a project revision (NAN_METHOD).

Parameter	Type	Description
User	String	User name
Branch	String	Branch
Project	String	Projekt

---

25. Authentication & Login#

LR_LoginToServer#

Authenticated with username and password. Synchronous.

Parameter	Type	Description
User	String	User name
Password	String	Passwort

LR_LoginToServerAsync#

Asynchronous login.

Parameter	Type	Description
User	String	User name
Password	String	Passwort
StorePassword	Bool	Save login details

LR_LoginToServerSSOAsync#

SSO login.

Parameter	Type	Description
User	String	User name
UUID	String	SSO token

LR_LoginStoredData#

Login with saved login details.

Parameter	Type	Description
Token	String	Auth token
User	String	User name
Licence	String	License key
DefaultResourceUser	String	Default resource user

LR_LogOutFromServer#

Logs out of the server. No parameters.

LR_ValidateToken#

Checks token validity. Returns JSON (Valid, User).

LR_GetLoggedInUser#

Returns information about the current user. Returns JSON (User, DefaultResourceUser, License).

LR_TryToGetUserAccountAsync#

Gets user account information. Asynchronous. No parameters.

LR_ResetPassword#

Resets the user password.

Parameter	Type	Description
User	String	User name

LR_ValidateUserNameAsync#

Validates a username. Asynchronous.

Parameter	Type	Description
User	String	Username to validate

---

26. Collaboration & Sharing#

LR_GetProjectMembers#

Lists project collaborators. Asynchronous. Returns JSON.

LR_AddProjectMember#

Adds a collaborator to the project.

Parameter	Type	Description
UserToReplace	UUID	User to replace (optional)
User	String	User to add

LR_SetRoleInProject#

Sets a user's role.

Parameter	Type	Description
User	String	User name
Role	String	Rollenname

LR_SendInvite#

Sends a project invitation.

Parameter	Type	Description
toInviteMail	String	E-mail address

LR_FindUserSubset#

Searches for users.

Parameter	Type	Description
searchQuery	String	Suchbegriff

LR_CreateShareLinkForProject#

Creates a shareable link for the project.

Parameter	Type	Description
Name	String	Linkname

LR_GetShareLinksForProject#

Lists existing sharing links. Asynchronous. Returns JSON.

LR_ShowShareDialog#

Opens the release dialog. No parameters.

LR_GetCollaboratorsAsync#

Gets the employee list. Asynchronous.

Parameter	Type	Description
User	String	User name

LR_CreateNewProjectAsync#

Creates a new project on the server. Asynchronous.

Parameter	Type	Description
Name	String	Project name
selectedFolder	String	Target folder
Collaborators	Array	Collaborator list
Checks	Object	Test configuration
Invites	Object	Invitation list
Groups	Object	Groupnzuweisungen
ForUser	String	Owner username
PrettyName	String	Display name
SymbolMapTemplate	String	Icon map template
BaseProject	String	Base project
Review	String	Reviewtyp

LR_GetProjectsAsync#

Lists projects. Asynchronous.

Parameter	Type	Description
User	String	User name

LR_GetOrganizationsAsync#

Lists organizations. Asynchronous.

Parameter	Type	Description
User	String	User name

LR_GetFoldersAsync#

Lists folders. Asynchronous.

Parameter	Type	Description
User	String	User name

---

27. Templates: Cross Sections#

LR_GetTrussCrossSection#

Returns all cross-section definitions. Returns JSON.

LR_GetTrussCrossSectionByName#

Searches for a cross section by name.

Parameter	Type	Description
Name	String	Querschnittsname

LR_SetCrossSectionTemplate / LR_AddCrossSectionTemplate / LR_DeleteCrossSectionTemplate / LR_DuplicateCrossSectionTemplate#

CRUD for cross-section templates. Set/Delete/Duplicate accept name (string). Add requires no parameters (from input object).

---

28. Templates: Materials#

LR_GetMaterialTemplates#

Lists all materials. Returns JSON.

LR_SetMaterialTemplate / LR_AddMaterialTemplate / LR_DeleteMaterialTemplate#

CRUD for material templates. Set/Delete accept name (string).

---

29. Templates: Symbol Maps#

LR_AddSymbolMap#

Adds a symbol mapping entry.

Parameter	Type	Description
From	String	Quellname
ToName	String	Zielname
ToUUID	UUID	Target UUID
ToRessourceIdent	String	Resource identifier
User	String	User name

LR_DeleteSymbolMap#

Deletes symbol mappings.

Parameter	Type	Description
FromArray	Array	Source names to delete

LR_GetSymbolMap#

Returns all symbol mappings. Returns JSON.

LR_SetSymbolMapTemplate / LR_NewSymbolMapTemplate / LR_DeleteSymbolMapTemplate / LR_UpdateFromSymbolMapTemplate#

Template operations. Each accepts name/template (string).

LR_GetSymbolMapTemplates#

Lists available templates.

Parameter	Type	Description
User	String	User name

---

30. Templates: Trucks, Cases & Racks#

LR_AddTruckTemplate#

Creates a truck template.

Parameter	Type	Description
Name	String	Vorlagenname
Size, Size, Size S	Double	Dimensions
AllowablePayload	Double	Maximum payload

LR_DeleteTruckTemplate / LR_SetTruckTemplate#

Deletes/updates a truck template. Accepts name (string).

LR_GetTruckTemplateMap#

Lists truck templates. Returns JSON.

LR_AddCaseTemplate#

Creates a case template.

Parameter	Type	Description
Name	String	Vorlagenname
Size, Size, Size S	Double	Dimensions
Weight	Double	Case weight

LR_DeleteCaseTemplate / LR_UpdateCaseTemplate#

Deletes/updates a case template. Each takes name (string).

LR_AddCaseTemplateSymbol / LR_RemoveCaseTemplateSymbol#

Adds or removes icons from a case template.

Parameter	Type	Description
CaseName	String	Case template name
SymbolUuid	UUID	Symbol (only for Remove)

LR_SetCaseTemplateSymbols#

Sets all icons for a case template.

Parameter	Type	Description
CaseName	String	Case template name
CaseSymbols	Array	Symboldaten

LR_GetCaseTemplateMap#

Lists case templates. Returns JSON.

LR_AddRackTemplate / LR_SetRackTemplate / LR_DeleteRackTemplate#

CRUD for rack templates. Set/Delete accept name (string).

LR_GetRackTemplateMap#

Lists rack templates. Returns JSON.

---

31. Templates: Paper & Print Formats#

LR_SetPaperFormatTemplate / LR_AddPaperFormatTemplate / LR_DeletePaperFormatTemplate#

CRUD for paper format templates. Set/Delete accept name (string).

LR_GetPaperFormatTemplateMap#

Lists paper sizes. Returns JSON.

LR_UsePaperFormatTemplate#

Applies a paper size to the drawing. Accepts name (string). Returns JSON.

LR_SetPrintFormatTemplate / LR_AddPrintFormatTemplate / LR_DeletePrintFormatTemplate#

CRUD for print format templates. Set/Delete accept name (string).

LR_GetPrintFormatTemplateMap#

Lists print formats. Returns JSON.

LR_GetSetSelectedPrintFormatTemplate#

Gets or sets the selected print format. Accepts name (string, optional). Returns JSON.

---

32. Templates: Property Templates#

LR_GetPropertyTemplateMap#

Lists property templates. Returns JSON.

LR_GetPropertyTemplate#

Returns a property template. Accepts name (string). Returns JSON.

LR_AddPropertyTemplate#

Creates a property template.

Parameter	Type	Description
Name	String	Vorlagenname
WorksheetState	Object	Worksheet state data

LR_DeletePropertyTemplate / LR_SetPropertyTemplate#

Deletes/updates a property template. Accepts name (string).

LR_GetInventoryPropertyTemplateMap#

Lists inventory property templates. Returns JSON.

LR_GetInventoryPropertyTemplate#

Returns an inventory property template. Accepts name (string). Returns JSON.

LR_AddInventoryPropertyTemplate#

Creates an inventory property template.

Parameter	Type	Description
Name	String	Vorlagenname
WorksheetState	Object	Worksheet state data

LR_SetInventoryPropertyTemplate#

Updates an inventory property template. Accepts name (string).

---

33. Templates: Connectors#

LR_GetConnectors_Data#

Returns the data connector library. Returns JSON.

LR_GetConnectors_Electric#

Returns the electrical connector library. Returns JSON.

LR_SetConnectorsTemplate#

Updates a connector template.

Parameter	Type	Description
updateAllConnectors	Bool	Apply to everyone
Name	String	Connector name (in the object)

LR_AddConnectorsTemplate#

Creates a connector template from the input object.

LR_DeleteConnectorsTemplate#

Deletes a connector template. Accepts name (string).

---

34. Templates: Bridle Parts Sets#

LR_GetBridlePartsSetTemplates#

Lists bridle parts set templates. Returns JSON.

LR_SetBridlePartsSetTemplate / LR_AddBridlePartsSetTemplate / LR_DeleteBridlePartsSetTemplate#

CRUD for Bridle parts set templates. Set/Delete accept name (string).

---

35. Templates: Calculation & Documentation Reports#

LR_AddCalculationReportTemplate#

Creates a calculation report template.

Parameter	Type	Description
Name	String	Vorlagenname
Report	String	Report Markdown
BackgroundTemplateUUID	UUID	UUID of the background label
FirstPageBackgroundTemplateUUID	UUID	UUID of the first page designation
PublicShareToken	String	Release token
PdfFormatName	String	PDF format name

LR_DeleteCalculationReportTemplate#

Deletes a report template. Accepts name (string).

LR_GetCalculationReportTemplateMap#

Lists calculation report templates. Returns JSON.

LR_SetCalculationReportTemplate#

Updates a report template. Accepts name (string).

LR_AddPaperworkReportTemplate#

Creates a documentation report template.

Parameter	Type	Description
Name	String	Vorlagenname
Report	String	Report Markdown

LR_DeletePaperworkReportTemplate / LR_SetPaperworkReportTemplate#

Delete/Update accept name (string).

LR_GetPaperworkReportTemplateMap#

Lists documentation report templates. Returns JSON.

LR_SetCalculationReportMarkdown#

Sets the active calculation report template.

Parameter	Type	Description
Report	String	Report Markdown
SimpleProjectDescription	String	Project description
Front	UUID	UUID of the front page name
Back	UUID	UUID of the background label

LR_GetCalculationReportMarkdown#

Returns the report template. Returns JSON (Report, Front, Back, ShareLink, PDFFormatName).

LR_SetPaperworkReportMarkdown#

Sets the active documentation report template.

Parameter	Type	Description
Report	String	Report Markdown
Front	UUID	UUID of the front page name
Back	UUID	UUID of the background label

LR_GetPaperworkReportMarkdown#

Returns the documentation report template. Returns JSON (Report, Front, Back).

---

36. VW Field Mapping#

LR_GetVWFieldMap#

Returns Vectorworks field mappings. Returns JSON.

LR_AddVWFieldMap#

Adds a field mapping. Accepts Entry (Object).

LR_DeleteVWFieldMap#

Deletes a field mapping. Accepts Entry (Object).

LR_UpdateVWFieldMap#

Updates a field mapping.

Parameter	Type	Description
Name	String	Mapping name
Entry	Object	Mapping data

LR_GetPossibleFields#

Lists available fields for mapping.

Parameter	Type	Description
IncludeGlobalProperties	Bool	Include global properties (optional)

LR_GetPossibleFieldsCases#

Lists case-specific fields. Returns JSON.

LR_GetPossibleFieldsRacks#

Lists rack-specific fields. Returns JSON.

LR_GetPossibleFieldsGeometry#

Lists geometry-specific fields. Returns JSON.

LR_GetLocalPlugInFields#

Lists custom plugin fields. Returns JSON.

---

37. Color Codes#

LR_AddNewColorCodeObject#

Creates a color code. Returns JSON.

LR_GetColorCodeObjects#

Lists all color codes. Returns JSON.

LR_SetColorCodeObject / LR_DeleteColorCodeObject / LR_GetColorCodeObject#

CRUD operations. Each accepts UUID.

---

38. Departments#

LR_AddNewDepartment#

Creates a department. Returns JSON.

LR_GetDepartments#

Lists all departments. Returns JSON.

LR_GetDepartment / LR_SetDepartment / LR_DeleteDepartment#

Individual departmental operations. Each accepts UUID.

---

39. Load Combinations & Groups#

LR_AddNewLoadCombination#

Creates a load combination. Returns JSON.

LR_GetLoadCombinations#

Lists load combinations. Returns JSON.

LR_GetLoadCombination#

Gets a single load combination. Accepts UUID. Returns JSON.

LR_SetLoadCombination / LR_DeleteLoadCombination#

Updates/deletes a load combination. Accepts UUID.

LR_GetActiveLoadCombination#

Returns the active load combination. Returns JSON.

LR_SetActiveLoadCombination / LR_SetActiveLoadCombinationSupport / LR_SetActiveLoadCombinationTipping#

Sets active combinations for different calculation modes. Each accepts UUID.

LR_AddNewLoadGroup#

Creates a load group. Returns JSON.

LR_GetLoadGroups#

Lists load groups. Returns JSON.

LR_GetLoadGroup#

Gets a single load group. Accepts UUID. Returns JSON.

LR_SetLoadGroup / LR_DeleteLoadGroup#

Updates/deletes a load group. Accepts UUID.

---

40. Structural Calculations & Results#

LR_GetStructures#

Returns structural analysis data.

Parameter	Type	Description
RootObject	UUID	Root element (optional)
UseSelected	Bool	Selected objects only

LR_GetStructuresRaw#

Returns raw structural data.

Parameter	Type	Description
RootObject	UUID	Root element (optional)
UseSelected	Bool	Selected objects only

LR_SelectConnectedStructure#

Selects all structurally connected parts.

Parameter	Type	Description
Object	UUID	Ausgangsobjekt

LR_AddNewWindLoad#

Creates a wind load.

Parameter	Type	Description
LoadBottom	Double	Load value below
LoadHeigth	Double	load height
ForceAngle	Double	Kraftwinkel
LoadTop	Double	Load value above

LR_AddNewLineLoad#

Creates a line load.

Parameter	Type	Description
X, Y, Z	Double	Load direction/position
Name	String	Lastname
GKS	Bool	Global coordinate system

LR_AddNewPointLoad#

Creates a point load.

Parameter	Type	Description
X, Y, Z	Double	Position
Height	Double	Height
Percent	Double	Lastprozentsatz
Name	String	Lastname
ByHeight	Bool	Position over height
GKS	Bool	Global coordinate system

LR_AddNewPointLoad_into_Symbol#

Creates a point load within a symbol definition.

Parameter	Type	Description
Symbol	UUID	Symboldefinition
X_Force, Y_Force, Z_Force	Double	Kraftkomponenten

LR_AddNewConnection#

Creates a structural connection.

Parameter	Type	Description
Type	Integer	Verbindungstyp
Object1-5	UUID	Connected objects
Point1-5 X/Y/Z	Double	Verbindungspunkte
TrussCross	String	Kreuzversteifungstyp

LR_StackTrussObjects#

Stacks two truss elements.

Parameter	Type	Description
Object1	UUID	First truss
Object2	UUID	Second truss

LR_OverwriteCrossSection#

Overwrites cross sections on selected objects.

Parameter	Type	Description
Objects	Array	Zielobjekte
Payload	String	Zielbezeichner
ToCrossSection	String	New cross section

LR_PlaceToStructure#

Places objects on structural elements.

Parameter	Type	Description
Structures	Array	Structure UUIDs
UseSelectedObjects	Bool	Use current selection
Alignment	Integer	Ausrichtungsmodus
AlternateAlignment	Integer	Alternative orientation
UseAlternateAlignment	Bool	Use alternative orientation
Object	UUID	Object to place
ResourceType	Integer	Resource type
ParentObject	UUID	Parent object
Count	Integer	Number of placements
Offset	Object	Versatzwerte

LR_RunPlaceToStructure#

Executes a pending placement. No parameters.

LR_ConvertToStructure#

Converts selected objects to structural elements. No parameters.

LR_ReRunStructuralCalculation / LR_ReReadAndRunStructuralCalculation / LR_AwaitCalculate / LR_CalculateStiffnessValuesForLoad / LR_CalculateConstructionHeight / LR_CalculateLoadForHoist / LR_CalculateBallastForGroundSupports / LR_RunSupportWorker#

Calculation operations. No parameters.

LR_SimulateWindLoad#

Simulates a wind load.

Parameter	Type	Description
Angle	Double	Windwinkel

LR_CalculateChainShortenEffect#

Calculates the effect of chain shortening.

Parameter	Type	Description
Delta	Double	Deltawert
AskForDelta	Bool	Query users

LR_PlaceHoistsToStructure#

Places hoists automatically.

Parameter	Type	Description
Objects	Array	Strukturobjekte
MaxForce	Double	Maximum permissible force

LR_SetCalculationObject#

Configures calculation objects.

Parameter	Type	Description
Clear	Bool	Delete existing ones

LR_GetObjectsToCalculate#

Returns objects included in the calculation. Returns JSON.

LR_GetStructuralResult / LR_GetLoadsResult / LR_GetWindLoadsResult / LR_GetWindLoads2Result#

Returns calculation results. Each returns a JSON array.

LR_GetCalcResults#

Returns current calculation results. Returns JSON.

LR_StoreResultsAsStructuralBenchmark#

Saves calculation results as a benchmark.

Parameter	Type	Description
StoreDu/Dx/Dy/Dz/etc.	Bool	Which results should be saved
ThresholdDu/Dx/Dy/Dz/etc.	Double	Schwellenwerte

LR_ShowStructuralWizard#

Opens the Structure Setup Wizard. No parameters.

LR_RunStructuralWizard#

Runs the Structure Wizard.

Parameter	Type	Description
SelectedLocation	String	Location
SelectedWindLoad	String	Windlastprofil
SelectedAreaLoad	String	Area load profile
SelectedBallast	String	Ballastkonfiguration
SelectedFloorLoad	String	Bodenlastprofil

---

41. Support & Hoisting#

LR_GetSupportList#

Lists support objects.

Parameter	Type	Description
Type	Integer	Support type filter

LR_GetAvailableOrigins#

Returns available hoisting origin points. Asynchronous. Returns JSON.

LR_SetHoistOrigin#

Sets the attachment point for hoisting.

Parameter	Type	Description
ParentUuid	UUID	Parent object
GeometryUuid	UUID	Geometry attachment point

LR_OpenChangeOrigin#

Opens the origin selection dialog.

Parameter	Type	Description
UUID	UUID	Objekt

LR_ChangeOrigin#

Changes a hoisting origin point.

Parameter	Type	Description
GlobalCoordinates	Bool	Use global coordinates
UUID	UUID	Objekt
OffsetX, OffsetY, OffsetZ	Double	Versatzwerte

LR_SelectSystemObjectS#

Selects all objects in a hosting system.

Parameter	Type	Description
UUID	UUID	System root object

LR_SetUsedSupportParts#

Sets support parts.

Parameter	Type	Description
LegIdx	Integer	Leg index
atBasket	Bool	At the basket position
Add	Bool	Add or remove
PartNam	String	Teilbezeichnung
PartUid	UUID	Part-UUID

LR_SetRopeOffsetOfBridle#

Adjusts the rope offset of a bridle.

Parameter	Type	Description
UUID	UUID	Bridle object
Offset	Double	Versatzabstand

---

42. Timeline & Phases#

LR_AddNewTimePhase#

Creates a time phase. Returns JSON.

LR_DeleteTimePhase / LR_SetTimePhase#

Delete/update time phase. Accepts UUID.

LR_GetTimePhases#

Lists all time phases. Returns JSON.

LR_SetTimePhaseOrder / LR_SetTimePhaseChangeOrder#

Reorders phases/changes. Accepts array.

LR_AddNewTimePhaseChange#

Creates a change within a phase.

Parameter	Type	Description
UUID	UUID	Phase UUID

LR_DeleteTimePhaseChange / LR_SetTimePhaseChange / LR_GetTimePhaseChange#

CRUD for phase changes. Each function accepts UUID.

LR_GetTimePhaseChanges#

Lists changes in a phase. Accepts UUID. Returns JSON.

LR_GetNeededTimeFromPhase#

Returns time requests. Returns JSON.

LR_PlayTimelineUntil#

Plays the animation up to a certain point.

Parameter	Type	Description
HighlightUUID	UUID	Object to be highlighted
UUID	UUID	Zielphase

LR_GetTimeLineStepData#

Returns details about a timeline step. Asynchronous.

Parameter	Type	Description
UUID	UUID	Phase UUID

LR_ResetHighlight#

Removes timeline highlighting. No parameters.

---

43. Notes#

LR_AddNewNote#

Creates a note.

Parameter	Type	Description
LinkedObject	UUID	Object to map (optional)

LR_DeleteNote / LR_SetNote#

Delete/update note. Accepts UUID.

LR_GetNotes#

Lists all notes. Returns JSON.

LR_GetNotesForObjects#

Returns notes for specific objects. Asynchronous.

Parameter	Type	Description
Selected	Bool	Use current selection
Worksheet	UUID	Filter by worksheet

---

44. Saved Views#

LR_AddNewSavedView#

Creates a saved view. Returns JSON.

LR_GetSavedViews#

Lists saved views. Returns JSON.

LR_ShowSavedView / LR_SetSavedView / LR_DeleteSavedView / LR_GetSavedView#

View operations. Each function accepts UUID.

---

45. Print Labels#

LR_AddNewPrintLabel#

Creates a print label. Returns JSON.

LR_GetPrintLabels#

Lists all print labels and fields. Returns JSON.

LR_GetPrintLabel / LR_SetPrintLabel / LR_DeletePrintLabel#

Individual label operations. Each function accepts UUID.

LR_SetPrintLabelFields#

Configures the visible fields on a label.

Parameter	Type	Description
UUID	UUID	Label
VisibleFields	Array	Fields to display

LR_PrintLabels#

Exports labels as PDF. Asynchronous.

Parameter	Type	Description
Path	String	Output path (optional)
LabelUUID	UUID	Label template
WorksheetUUID	UUID	Worksheet filter
PublicShareLink	String	Share link
OnlySelected	Bool	Selected objects only
TrussTapeMode	Bool	Truss tape mode
SheetLayerMode	Bool	Slide layer mode
TrussTapeModePrintSteps	Bool	Print steps
TrussTapeMeasureFromMiddle	Bool	Measure from the center
TrussTapeModeStepsWidth	Double	Step width
TrussTapeCorrectionFactor	Double	Correction factor
OriginParentId	UUID	Origin parent object
OriginGeoId	UUID	Origin geometry
PageInfo	Object	Page layout information
LocalizedStrings	Object	Localization data

LR_SelectPrintLabelField#

Selects a field in the label editor.

Parameter	Type	Description
LabelUUID	UUID	Label
LabelField	String	Field identifier

LR_ResetSelectedLabelFields#

Resets fields on a label.

Parameter	Type	Description
LabelUUID	UUID	Label

---

46. Graph Groups#

LR_SetGraphGroupInfo#

Configures a chart group.

Parameter	Type	Description
UUID	UUID	Group
Name	String	Group name
isCollapsed	Bool	Folded state
forElectricGraph	Bool	Electrical diagram
Color	String	Group color
position	Object	Position data
childNodes	Array	UUIDs of the child nodes
NoNewUndoEvent	Bool	Skip undo tracking

LR_RemoveObjectsFromGraphGroup#

Removes objects from a chart group.

Parameter	Type	Description
ObjectsToUnlink	Array	Objects to remove

LR_RepositionNodesInWrapper#

Automatically arranges nodes in a wrapper.

Parameter	Type	Description
UUID	UUID	Wrapper object

LR_DeleteGraphGroup#

Deletes a chart group. Accepts UUID.

LR_GetGraphGroupInfos#

Lists chart groups.

Parameter	Type	Description
ForElectricGraph	Bool	Filter by electrical diagram

LR_ResetElectricalPosition#

Resets the positions in the electrical layout.

Parameter	Type	Description
ForElectricGraph	Bool	Electrical diagram

---

47. Batch & Array Operations#

LR_StartBatchOperation#

Begins a grouped batch operation.

Parameter	Type	Description
NoUndoTracking	Bool	Skip undo tracking

LR_EndBatchOperation#

Ends a batch operation.

Parameter	Type	Description
MakeDrawingActive	Bool	Update user interface

LR_InsertDropForSelectedObjects#

Inserts drops/chains on selected objects.

Parameter	Type	Description
UUID	UUID	Specific object (optional)

LR_InsertRopeForSelectedLoadObjects / LR_InsertBridleForSelectedLoadObjects / LR_InsertGrappelsForSelectedObjects / LR_InsertBridlesForSelectedObjects / LR_InsertTrussCrossForSelectedObjects / LR_InsertHouseRiggingPoints#

Rigging creation operations. No parameters.

LR_CurveTrussForSelectedObjects#

Applies curvature to selected trusses. No parameters.

LR_CreateAssemblyGroupFromStructures#

Creates assembly groups from structural analysis. No parameters.

LR_MergeSelectedObjects#

Merges selected objects. No parameters.

---

48. Ordering Operations#

All sorting functions follow the same pattern:

Parameter	Type	Description
UUID	UUID	New item to be sorted
Index	Integer	New position

Features: LR_ChangeWorksheetOrder, LR_ChangeLayerOrder, LR_ChangeClassOrder, LR_ChangeColorCodeObjectOrder, LR_ChangeDepartmentObjectOrder, LR_ChangeLoadCombinationOrder, LR_ChangeLoadGroupOrder, LR_ChangeSavedViewOrder, LR_ChangeTruckOrder, LR_ChangePrintLabelOrder, LR_ChangeCaseOrder, LR_ChangeRackOrder

---

49. Undo/Redo#

LR_DoUndo#

Undoes the last action. No parameters.

LR_DoRedo#

Redoes the last undone action. No parameters.

---

50. Clipboard Operations#

LR_CopyObject#

Copies an object to the clipboard.

Parameter	Type	Description
UUID	UUID	Object to copy

LR_CutObject#

Cuts selected objects to the clipboard. No parameters.

LR_PasteObject#

Pastes from the clipboard. No parameters.

---

51. Duplication & Mirroring#

LR_DuplicateObject#

Duplicates an object. Accepts UUID.

LR_DuplicateSelectedObject#

Duplicates selected objects. No parameters.

LR_DuplicateSelectedObjectXYZ#

Duplicated along the specified axes.

Parameter	Type	Description
X	Bool	Duplicate along X
Y	Bool	Duplicate along Y
Z	Bool	Duplicate along Z

LR_DuplicateSelectedObjectX_P / LR_DuplicateSelectedObjectX_N / LR_DuplicateSelectedObjectY_P / LR_DuplicateSelectedObjectY_N / LR_DuplicateSelectedObjectZ_P / LR_DuplicateSelectedObjectZ_N#

Directed duplication along the positive/negative axes. No parameters.

LR_MirrorSelectedObject#

Reflects selected objects on a layer.

Parameter	Type	Description
Px1, Py1, Pz1	Double	First level point
Px2, Py2, Pz2	Double	Second level point

---

52. Patching & Data Patching#

LR_PatchSelectedObjects#

Patches selected objects.

Parameter	Type	Description
Type	Integer	Patch Type

LR_HotPatchSelectedObjects#

Hot-patches selected objects.

Parameter	Type	Description
Type	Integer	Patch Type

LR_PatchChildObjects#

Patches all children of an object. Accepts UUID.

LR_DataPatchSelectedObjects#

Data patches selected objects. No parameters.

LR_DataPatchChildObjects#

Data patches children of an object. Accepts UUID.

LR_PatchToObject#

Copies patch data between objects.

Parameter	Type	Description
AltPressed	Bool	Alternative mode
Objects	Array	Target UUIDs

Returns JSON (Total, Patched, LastConsumer, LastProducer).

---

53. Assembly Groups & Sorting#

LR_GetAssemblyGroups#

Lists assembly groups. Returns JSON.

LR_MoveToAssemblyGroup#

Moves objects into an assembly group.

Parameter	Type	Description
UUID	UUID	Target group (optional)

LR_CreateGroupsByProperty#

Automatically creates groups based on property values.

Parameter	Type	Description
Property	String	Property to be grouped by

LR_DeleteEmptyAssemblyGroups#

Removes empty assembly groups. No parameters.

LR_CreateChildAssemblyGroup#

Creates a nested child group.

Parameter	Type	Description
Child	UUID	Child object

LR_SortFixtureByProperty#

Sorts fixtures by a property value.

Parameter	Type	Description
Ident	String	Property identifier
Parent	UUID	Parent object

LR_SortFixturesByPositionOnStruct#

Sorts fixtures by their position along a structure.

Parameter	Type	Description
Root	UUID	Structure root object (optional)

---

54. Settings & Configuration#

LR_GetGlobalSettings#

Returns application-wide settings. Returns JSON (GlobalSettings, GlobalSettingsGrouping).

LR_GetDefaultGlobalSettings#

Returns factory settings. Returns JSON.

LR_SetGlobalSettings#

Updates global settings. Accepts a settings object.

LR_RunOpenSettings#

Opens the settings dialog. No parameters.

LR_GetProjectSettings / LR_GetDrawingSettings#

Returns drawing-level settings. Returns JSON.

LR_SetProjectSettings#

Updates drawing settings. Accepts a settings object.

LR_GetDrawingWorksheetState / LR_SetDrawingWorksheetState#

Reads/sets the worksheet state. Returns JSON / receives JSON.

LR_GetSceneTreeFilterState / LR_SetSceneTreeFilterState#

Reads/sets the tree filter state. Returns JSON / receives JSON.

LR_GetEditModeWorksheetState#

Returns the worksheet state in edit mode. Returns JSON.

LR_GetAppDisplayState / LR_SetAppDisplayState#

Reads/sets the UI layout state. Returns JSON / receives JSON.

LR_SetCellData#

Updates cell data in a worksheet.

Parameter	Type	Description
WorksheetData	Object	Cell updates
Worksheet	UUID	Worksheet (optional)

LR_GetCellState#

Returns the cell state.

Parameter	Type	Description
Worksheet	UUID	Worksheet (optional)

LR_GetShortCutsSettings#

Returns keyboard shortcuts.

Parameter	Type	Description
AsArray	Bool	Return as array (optional)

LR_SetShortCut#

Assigns a keyboard shortcut.

Parameter	Type	Description
ShortCut	Object	Keyboard shortcut definition

LR_ResetShortCutSettings#

Resets all keyboard shortcuts to default values. No parameters.

LR_SetTableViewLocalization#

Sets the localization of the table view.

Parameter	Type	Description
LANG	String	Language code
Locale	Object	Localization data

LR_SetOnlineConfig#

Sets the online configuration.

Parameter	Type	Description
HTTP	String	HTTP URL
HTTPS	String	HTTPS URL
User	String	User name

LR_SetOnlineServerDirect#

Configures the server connection directly.

Parameter	Type	Description
HTTP	String	HTTP URL
HTTPS	String	HTTPS URL
Sharetoken	String	Share token (optional)

LR_GetOnlineConfig#

Returns the server configuration. Used LR_GetBaseURL for the server URL.

---

55. Dialogs & User Interface#

LR_ShowModalDialog#

Displays a modal dialog.

Parameter	Type	Description
Dialog	String	Dialogue type
Property	String	Property name
BaseUnit	Integer	Unit type
InitValue	String	Initial value

LR_ShowCreateWorksheetDialog#

Opens the dialog for creating a worksheet.

Parameter	Type	Description
AllAssemblyGroups	Bool	Include all groups (optional)
UUID	UUID	Target object (optional)

LR_ShowArrayModifierDialog#

Opens the array creation dialog.

Parameter	Type	Description
UUID	UUID	Target object (optional)

LR_ShowChangeFixtureType#

Opens the fixture type selection.

Parameter	Type	Description
UUID	UUID	Target object (optional)

LR_ShowConnectToRemote / LR_ShowAboutDialog / LR_ShowVRDialog / LR_ShowCalculationSettings / LR_OpenFixtureNumbering / LR_RenameProperty / LR_ShowAddUserToProject / LR_ShowCreateDrawingNote / LR_OpenCalendar / LR_MakeFeedbackInApp / LR_ShowEditShortCutsModal#

Dialogue trigger. No parameters.

LR_ShowResultsForSelection#

Displays calculation results for the selection.

Parameter	Type	Description
Object	UUID	Object (optional)
Geometry	UUID	Geometry (optional)

LR_ZoomToSelection#

Zooms the viewport to the selected objects. No parameters.

LR_SetRendererView / LR_ArrangeSelectedObjects / LR_ActivateInputField#

View and UI operations. No explicit parameters (use input object).

LR_AlignOn#

Activates the alignment tool.

Parameter	Type	Description
Px, Py, Pz	Double	Alignment point

LR_ReturnAwaitValueFromFrontend#

Returns a value from an asynchronous frontend operation.

Parameter	Type	Description
AwaitID	UUID	ID of the asynchronous operation
Payload	Object	Return value

LR_ToggleRenderingMode#

Switches between rendering modes. No parameters.

LR_OpenHelp#

Opens the help documentation.

Parameter	Type	Description
Page	String	Help page (optional)

LR_OpenLink#

Opens a URL.

Parameter	Type	Description
URL	String	Link target
UseBaseUrl	Bool	Prefix server base URL

LR_OpenCurrentOnline#

Opens the current document on the server. No parameters.

LR_OpenLocalRessourceFolder#

Opens the local resources directory in File Explorer. No parameters.

---

56. Print & Export Views#

LR_PrintTable#

Exports a table/worksheet as PDF.

Parameter	Type	Description
Path	String	Output path (optional)
Type	String	Exportformat
HTML	String	HTML content
Worksheet	UUID	Worksheet
ShareLink	String	Share link
PrintScale	Double	Scaling factor
ImageHeight, ImageWidth	Integer	Image dimensions
ActivePreset	String	Active default
UsePageBreak	Bool	Enable page breaks
AddHeaderSection	Bool	Include head area
PrintLabelBackground	UUID	Background label
PDFFormats	Object	PDF format settings

LR_PrintElectricalViewToFile#

Exports an electrical view to a file. Asynchronous.

Parameter	Type	Description
Path	String	Output path (optional)
Type	String	Exportformat
ImageData	String	Image content
ImageHeight, ImageWidth	Double	Dimensions
MarginTop/Right/Bottom/Left	Double	Margins
PrintScale	Double	scale
AddHeaderSection	Bool	Include head area
PrintLabelBackground	UUID	Background label
PDFFormats	Object	PDF format settings

LR_ExportStructuralReport#

Exports the structural analysis report as PDF. Asynchronous.

Parameter	Type	Description
Path	String	Output path (optional)
Password	String	PDF password
SignOnline	Bool	Online signing
SelectedPrintLabelFrontPage	UUID	Front page label
SelectedPrintLabelBackground	UUID	Background label
ProtocolDef	String	Protocol definition
SimpleProjectDescription	String	Description
ExportHoist, ExportDrop, ExportGroundSupport, ExportTrusses, ExportWindload, ExportFloorLoads	Bool	Section switch
SimpleAddCurrentView	Bool	Add current view
ExportSimpleWay	Bool	Simple export mode
ShowAlertWhenFinished	Bool	Notification upon completion
PDFFormatName	String	Format name
PublicShareLink, PublicShareLinkName	String	Share data

LR_ExportPaperworkReport#

Exports the paperwork report as PDF. Asynchronous.

Parameter	Type	Description
Path	String	Output path (optional)
ProtocolDef	String	Protocol definition
PublicShareLink	String	Share link
SelectedPrintLabelFrontPage	UUID	Front page label
SelectedPrintLabelBackground	UUID	Background label
PDFFormatName	String	Format name

LR_UploadProvedStructuralReport#

Uploads a verified structure report.

Parameter	Type	Description
Password	String	PDF password

LR_ExportView#

Exports a rendered view as PDF. Asynchronous.

Parameter	Type	Description
Path	String	Output path (optional)
PublicShareLink	String	Share link
SelectedPrintLabel	UUID	Drucketikett
SelectedView	UUID	View to render

---

57. MA3 / DMX Monitoring#

LR_ListenToMA3DMX#

Starts listening to MA3-DMX input. No parameters (reads from input object).

LR_StopListenToMA3DMX#

Stops the MA3-DMX listener. No parameters.

LR_GetDataForDMXUniverse#

Returns DMX channel data for a universe. Asynchronous.

Parameter	Type	Description
Universe	Integer	Universe number

---

58. Log100 Connections#

LR_AddNewLog100Connection#

Adds a load cell sensor connection. Returns JSON.

LR_GetLog100Connections#

Lists all sensor connections. Returns JSON.

LR_SetLog100Connections / LR_DeleteLog100Connections#

Update/delete connections. Accepts UUID.

LR_ShowLoadCellMonitor#

Opens the load cell monitor interface. No parameters.

---

59. Network & Remote Access#

LR_ConnectToRemote#

Connects to a remote server.

Parameter	Type	Description
IP	String	Host IP/Hostname
Port	String	Port number

LR_LRNET_ConnectionAccept#

Accepts an incoming remote connection request.

Parameter	Type	Description
SendDrawing	Bool	Send drawing data

LR_LRNETSendPing#

Tests the remote connection. No parameters.

LR_GetVersionInfo#

Returns build and version information. Returns JSON (GitHash, BuildNumber, VersionNumber, BuildType, Platform, UseUpdater, PID, BaseURL, WebsocketPort, WebServerPort, WebsocketURL).

LR_GetBaseURL#

Returns server URL information. Returns JSON (URL, User, Port, KeyTarEnabled).

LR_CheckForUpdate#

Checks for application updates. Asynchronous.

Parameter	Type	Description
Force	Bool	Force check

---

60. MVRxchange Integration#

LR_GetMVRxchangeServices#

Lists available MVRxchange services. Asynchronous. Returns JSON.

LR_GetMVRxchangeInterfaces#

Lists service interfaces. Asynchronous. Returns JSON.

LR_MVRxchnageSelectInterface#

Selects an MVRxchange interface.

Parameter	Type	Description
interfNam	String	Interface name

LR_GetMVRxchangeFiles#

Lists shared MVRxchange files. Returns JSON (External, Internal).

LR_CreateNewMVRxchangeRevision#

Creates a new MVRxchange commit.

Parameter	Type	Description
Description	String	Revision description

LR_GetMVRxchangeFile#

Downloads an MVRxchange file.

Parameter	Type	Description
UUID	UUID	File-UUID (optional)

LR_OpenMVRxchangeSettings#

Opens the MVRxchange configuration dialog. No parameters.

---

61. Host Application Integration#

LR_Import2DPlanFromHostApplication / LR_Import3DPlanFromHostApplication#

Imports 2D/3D plans from the host CAD application. No parameters.

LR_ImportStructuralMemberFromHoistApplication#

Imports structural data from the hoisting software. No parameters.

LR_PrepareSymbolsFromHostApplication / LR_RefreshSymbolsFromHostApplication#

Prepares/updates icons from the host application. No parameters.

LR_WriteSymbolsToHostApplication#

Exports symbols back to the host application. No parameters.

LR_InstallLightRightPlugin#

Installs the LightRight host application plugin.

Parameter	Type	Description
SelectedPackages	Array	Packages to install (optional)
Filter	String	Filter pattern

---

62. Linked Projects & Branches#

LR_GetLinkedProject#

Returns information about the linked project. Returns JSON (Project, Owner, Branch, UserRight, ResourceIdent, DefaultResourceUser, LinkedTemplate).

LR_SetLinkedProject#

Linked to a server project.

Parameter	Type	Description
Project	String	Project name
Branch	String	Branch name
Owner	String	owner

LR_GetRecentFiles#

Returns recently opened files. Returns JSON.

LR_OpenRecentChecked#

Opens a recently used file with validation.

Parameter	Type	Description
Path	String	File path

---

63. Custom Checks & Validation#

LR_GetChecksFromUser#

Returns custom checks. Asynchronous.

Parameter	Type	Description
User	String	User name

LR_GetChecksFromProject / LR_GetProjectOwnerChecks#

Returns project/owner checks. Asynchronous.

LR_AddCheckToProject / LR_AddCheckToUser#

Adds a test.

Parameter	Type	Description
Name	String	Exam name

LR_EditScriptInCheck#

Updates check logic.

Parameter	Type	Description
checkId	String	Exam ID
Script	String	Script code

LR_RemoveCheckFromProject / LR_RemoveCheckFromUser#

Removes a check.

Parameter	Type	Description
checkId	String	Exam ID

LR_ToggleProjectOwnerChecks#

Enables/disables a check.

Parameter	Type	Description
checkId	String	Exam ID
checked	Bool	Activation state

LR_EditCheckName#

Renames a test.

Parameter	Type	Description
checkId	String	Exam ID
Name	String	New name

LR_GetReviewsFromUser / LR_GetGroupsFromUser#

Returns reviews/groups for a user. Asynchronous.

Parameter	Type	Description
User	String	User name

LR_GetDrawingErrors#

Returns validation errors. Returns JSON.

---

64. Custom Scripts & Commands#

LR_JsEngineExecute#

Executes JavaScript code in the internal JS engine.

Parameter	Type	Description
ScriptName	String	Script name (optional)
Script	String	Script code

Returns JSON (Log, OK, ScriptError).

LR_CommandLine#

Executes a command line operation.

Parameter	Type	Description
ApplyToChildObject	Bool	Apply to child objects

LR_GetAvailableCommands#

Lists all available API commands. Returns JSON array.

---

65. Chatbot Settings#

LR_GetChatBotSettings#

Returns the chatbot configuration. Returns JSON.

LR_SetChatBotSettings#

Updates chatbot settings.

Parameter	Type	Description
Messages	Array	Chat messages

LR_EncryptJson#

Encrypts JSON data for secure storage. Returns JSON (Data).

---

66. Gels & Color Filtering#

LR_GetGelList#

Returns available gel colors. Returns JSON (GelRows).

LR_GetGelRolls#

Returns gel roll sizes. Returns JSON (GelRolls).

---

67. Property Management#

LR_SetPropertyName#

Sets the display name of a property.

Parameter	Type	Description
PropertyIdent	String	Property identifier
LocalizedName	String	Display name

LR_ClearPropertyName#

Resets the display name of a property.

Parameter	Type	Description
Ident	String	Property identifier

LR_GetPropertyLocalizedOverwrite#

Returns property name overrides. Returns JSON.

LR_RemoveColumn#

Removes a column from the table view. No parameters.

---

68. Costs & Pricing#

LR_GetCalculationPricing#

Returns a cost estimate for a calculation. Asynchronous.

Parameter	Type	Description
PricingArgs	Object	Pricing arguments
Voucher	String	Voucher code

LR_RequestCalculationCheck#

Requests a calculation review.

Parameter	Type	Description
Voucher	String	Voucher code
user_project_reference	String	Project reference
user_project_notes	String	Notes
user_project_location	String	Location
user_project_indoor	Bool	Indoor/Outdoor

LR_RequestCalculationQuote#

Requests a price quote. Same parameters as LR_RequestCalculationCheck.

LR_ShowRequestCalculationCheck#

Opens the calculation verification dialog. No parameters.

---

69. Digital Signing#

LR_GetSigningJob#

Returns information about a signing job. Asynchronous. Returns JSON.

LR_UpdateSigningJob#

Completes a signing job. Accepts object data. Asynchronous.

---

70. Tabular Calculations#

LR_GetTabledCalculations#

Lists pending calculations. Asynchronous. Returns JSON.

LR_CancelTabledCalculation#

Cancels a pending calculation.

Parameter	Type	Description
Owner	String	Project owner
Project	String	Project name
ID	String	Calculation ID

LR_DownloadTabledCalculation#

Downloads calculation results.

Parameter	Type	Description
Owner	String	Project owner
Project	String	Project name
ID	String	Calculation ID

---

71. Miscellaneous Utilities#

LR_GetSummeryList#

Returns project summary data.

Parameter	Type	Description
Worksheet	UUID	Worksheet filter (optional)

LR_GetGenerators#

Lists generator objects.

Parameter	Type	Description
onlyTrueGenerators	Bool	Filter for real generators

LR_ScaleByDistance#

Scales the drawing based on a measured and a desired distance.

Parameter	Type	Description
Measured	Double	Measured distance
Desired	Double	Desired distance

LR_RandomizeChainShorten#

Random chain shortening values.

Parameter	Type	Description
Min	Double	Minimum random value
Max	Double	Maximum random value

LR_AdjustChainShortens#

Adjusts chain shortening values. No parameters.

LR_ProcessMagicString#

Processes a special command string.

Parameter	Type	Description
MagicString	String	Command string

LR_GetAvailabelFonts#

Lists system fonts. Returns JSON.

LR_ConvertToPlane#

Converts an object to a 2D layer. No parameters.

LR_AddDimensions#

Adds dimensions to the drawing. No parameters.

LR_ShowTrussDataGenerator#

Opens the Truss Data Generator tool. No parameters.

LR_DebugGraphSystem#

Displays debug information for the electrical diagram. No parameters.

LR_GetTableViewGroupingData#

Returns grouped table data. Asynchronous.

Parameter	Type	Description
FirstUUID	UUID	Root object
WorksheetState	Object	Configuration
UseGrouping	Bool	Enable grouping

LR_GetProjectDataAsync#

Returns project data from the server. Asynchronous.

Parameter	Type	Description
Owner	String	Project owner
Project	String	Project name

LR_GetUserData / LR_GetUserDataAsync#

Returns user data. The asynchronous variant accepts TemplateOnly (Bool).

LR_GetDataForUserAsync#

Returns data for a specific user. Asynchronous.

Parameter	Type	Description
User	String	User name
TemplateOnly	Bool	Templates only

LR_GetProjectTasks#

Lists project tasks. Asynchronous. Returns JSON.

LR_GetWorksheetTask#

Returns task data for a worksheet. Asynchronous. Accepts UUID.

LR_SwitchTaskState#

Changes the status of a task.

Parameter	Type	Description
State	String	New condition
UUID	UUID	Aufgabe

LR_GetUserAvatarAsync#

Returns a user's avatar. Asynchronous.

Parameter	Type	Description
User	String	User name

---

72. Testing & Debugging#

LR_RunUnitTest#

Runs C++ unit tests.

Parameter	Type	Description
ShowAlert	Bool	Show notification on result
TestFilter	String	Test name filter

LR_GetUnittestNames#

Lists all registered test names. Returns JSON array.

LR_Test#

Generic test function. No parameters.

LR_TestSentry_Crash#

Triggers a test crash (memory access error). For crash reporting system testing only.

LR_TestSentry_StackOverflow#

Triggers a stack overflow. For crash reporting system testing only.