Skip to content
Trimble SketchUp

Naming

To make the API as regular as possible we try to follow these naming conventions:

Async Methods

Section titled “Async Methods”

Async methods will start with get.

Exceptions:

  • findEntity
  • findEntities
  • export (TBC)
  • refresh (TBC)
  • action methods that take immediate effect in SketchUp
    • undo
    • redo
    • updateSelection
    • … etc
    • scene.update
    • options.update

Operations

Section titled “Operations”

The SketchupOperation class contains methods to manipulate Sketchup within an operation. This attempts to hide the asynchronous nature of the API for both convenience and performance.

  • methods starting with create will create an entity or resource
  • methods that need to load a resource into SketchUp from a server will start with load and be async.
  • methods for a particular entity will be prefixed with that entity name (e.g) operation.faceSetBackMaterial

Synchronous Lookup Methods

Section titled “Synchronous Lookup Methods”

Synchronous lookup methods (other than those listed above) will start with .find