Model

Properties

attributes

readonly attributes: Attributes

The attribute dictionaries attached to the model.

guid

readonly guid: string

Globally unique identifier for this model.

id

readonly id: number

Session-specific numeric identifier for this model instance.

name

readonly name: string

Internal name of the model (typically the component definition name if this model was exported as a .skp and re-opened).

options

readonly options: ModelOptions

Model-level options (units, geolocation, etc.).

revision

readonly revision: number

Increments each time the model changes. Compare revisions to detect whether a snapshot is stale.

title

readonly title: string

The display title shown in the window title bar, based on the saved file name. Empty string if the model is unsaved.

tools

readonly tools: Tools

Helpers for activating built-in SketchUp tools.

view

readonly view: View

The active camera and view properties.

Accessors

entities

Get Signature

get entities(): CallableEntities

Returns an Entities collection for querying and modifying the drawing elements at the model root. Use entities.get() to retrieve faces, edges, groups, etc., optionally filtered by type.

Returns

CallableEntities

Methods

findEntities()

Call Signature

findEntities(id): Promise<(Entity | undefined)[]>

Bulk retrieval of fresh entity snapshots by ID. Returns undefined for any entity that no longer exists.

Parameters

Parameter	Type	Description
`id`	readonly `SketchupId`[]	Array of SketchupIds

Returns

Promise<(Entity | undefined)[]>

Call Signature

findEntities<T>(snapshot): Promise<(T | undefined)[]>

Bulk re-fetch of entity snapshots. Returns undefined for any entity that has been deleted since your snapshot was taken.

Type Parameters

Type Parameter
`T` extends `Entity`

Parameters

Parameter	Type	Description
`snapshot`	readonly `T`[]	Array of existing entity snapshots

Returns

Promise<(T | undefined)[]>

Call Signature

findEntities<Ref>(ref): Promise<(EntityFor<Ref> | undefined)[]>

Bulk retrieval from entity references. Returns undefined for any reference whose entity no longer exists.

Type Parameters

Type Parameter
`Ref` extends `EntityRef`

Parameters

Parameter	Type	Description
`ref`	readonly `Ref`[]	Array of entity references

Returns

Promise<(EntityFor<Ref> | undefined)[]>

Call Signature

findEntities(searchByItems): Promise<(Entity | undefined)[]>

Bulk retrieval of fresh entity snapshots by ID. Returns undefined for any entity that no longer exists.

Parameters

Parameter	Type
`searchByItems`	readonly (`SketchupId` \| `Entity` \| `EntityRef`)[]

Returns

Promise<(Entity | undefined)[]>

findEntity()

Call Signature

findEntity(id, options): Promise<Entity>

Retrieves a fresh snapshot of an entity by ID, erroring if not found.

Parameters

Parameter	Type	Description
`id`	`SketchupId`	The entity’s SketchupId
`options`	`StrictlyFindEntityOptions`	Pass `{ errorIfNotFound: true }` to throw on missing

Returns

Promise<Entity>

Throws

Error if the entity no longer exists

Call Signature

findEntity(id, options?): Promise<Entity | undefined>

Retrieves a fresh snapshot of an entity by ID, or undefined if deleted.

Parameters

Parameter	Type	Description
`id`	`SketchupId`	The entity’s SketchupId
`options?`	`FindEntityOptions`	Optional find settings

Returns

Promise<Entity | undefined>

Call Signature

findEntity<T>(snapshot, options): Promise<T>

Re-fetches an entity snapshot, erroring if it has been deleted.

Type Parameters

Type Parameter
`T` extends `Entity`

Parameters

Parameter	Type	Description
`snapshot`	`T`	An existing entity snapshot
`options`	`StrictlyFindEntityOptions`	Pass `{ errorIfNotFound: true }` to throw on missing

Returns

Promise<T>

Throws

Error if the entity no longer exists

Call Signature

findEntity<T>(snapshot, options?): Promise<T | undefined>

Re-fetches an entity snapshot, or undefined if it has been deleted.

Type Parameters

Type Parameter
`T` extends `Entity`

Parameters

Parameter	Type	Description
`snapshot`	`T`	An existing entity snapshot
`options?`	`FindEntityOptions`	Optional find settings

Returns

Promise<T | undefined>

Call Signature

findEntity<Ref>(ref, options): Promise<EntityFor<Ref>>

Retrieves a fresh snapshot from an entity reference, erroring if deleted.

Type Parameters

Type Parameter
`Ref` extends `EntityRef`

Parameters

Parameter	Type	Description
`ref`	`Ref`	An entity reference
`options`	`StrictlyFindEntityOptions`	Pass `{ errorIfNotFound: true }` to throw on missing

Returns

Promise<EntityFor<Ref>>

Throws

Error if the entity no longer exists

Call Signature

findEntity<Ref>(ref, options?): Promise<EntityFor<Ref> | undefined>

Retrieves a fresh snapshot from an entity reference, or undefined if deleted.

Type Parameters

Type Parameter
`Ref` extends `EntityRef`

Parameters

Parameter	Type	Description
`ref`	`Ref`	An entity reference
`options?`	`FindEntityOptions`	Optional find settings

Returns

Promise<EntityFor<Ref> | undefined>

getActivePath()

getActivePath(): Promise<ActivePath>

Queries the active editing context (the chain of groups or component instances the user has double-clicked into). Returns an empty path if editing at the model root.

Returns

Promise<ActivePath>

A promise resolving to the active path

Since

SDK 2.17.0 Protocol 1.14.0

getActiveSectionPlanes()

getActiveSectionPlanes(options?): Promise<readonly SectionPlane[]>

Queries the section planes that are currently active (cutting through the model). Section planes slice geometry to show interior views.

Parameters

Parameter	Type	Description
`options?`	`EntityQuery`	Optional filter to apply

Returns

Promise<readonly SectionPlane[]>

A promise resolving to the active section planes

Since

SDK 2.29.0 Protocol 1.13.0

getAxes()

getAxes(): Promise<Axes>

Queries the origin and orientation of the model’s global axes. These axes define the red, green, and blue direction vectors.

Returns

Promise<Axes>

A promise resolving to the model axes

getBounds()

getBounds(): Promise<BoundingBox>

Queries the axis-aligned bounding box that encloses all geometry in the model, in model coordinates.

Returns

Promise<BoundingBox>

A promise resolving to the model’s bounding box

Since

SDK 2.30.0 Protocol 0.7.0

getClassifications()

getClassifications(): Promise<ClassificationSchema[]>

Queries the classification schemas loaded in this model (IFC, gbXML, etc.). Used to annotate components with structured metadata.

Returns

Promise<ClassificationSchema[]>

A promise resolving to the list of schemas

Since

SDK 2.5.0 Protocol 1.3.0

getCRSLocation()

getCRSLocation(): Promise<CRSLocation | undefined>

Queries the Coordinate Reference System (CRS) location, which provides precise geospatial positioning for the model. Returns undefined if no CRS is set or the platform doesn’t support it.

Returns

Promise<CRSLocation | undefined>

A promise resolving to the CRS location, or undefined

Since

SDK 2.28.0 Protocol 1.25.0

getCurrentMaterial()

getCurrentMaterial(): Promise<Material | undefined>

Queries the material currently selected in SketchUp’s Materials panel. This is the material that will be painted when the user uses the Paint Bucket tool.

Returns

Promise<Material | undefined>

A promise resolving to the current material, or undefined if none

Since

SDK 2.30.0

getCurrentScene()

getCurrentScene(): Promise<Scene | undefined>

Queries the currently active scene (the one whose tab is selected). Returns undefined if the model has no scenes.

Returns

Promise<Scene | undefined>

A promise resolving to the current scene, or undefined

Since

SDK 2.29.0 Protocol 1.7.0

getCurvesForEdges()

getCurvesForEdges(edges): Promise<(ArcCurve | Curve)[]>

Retrieves the curves associated with a set of edges. Edges that belong to the same curve share a curve object. Edges not part of any curve are omitted from the result.

Parameters

Parameter	Type	Description
`edges`	readonly (`Edge` \| `EdgeRef`)[]	Array of edges or edge references

Returns

Promise<(ArcCurve | Curve)[]>

Array of curves (Curve or ArcCurve)

getDefinitions()

getDefinitions(): Promise<readonly ComponentDefinition[]>

Queries all component definitions in the model. Each definition can have multiple instances placed throughout the model.

Returns

Promise<readonly ComponentDefinition[]>

A promise resolving to the array of definitions

Since

SDK 2.30.0

getEntitiesBoundsByIds()

getEntitiesBoundsByIds(ids): Promise<BoundingBox[]>

Bulk queries for entity bounding boxes. Returns the boxes in the same order as the IDs you supplied.

Parameters

Parameter	Type	Description
`ids`	readonly `SketchupId`[]	Array of entity IDs

Returns

Promise<BoundingBox[]>

A promise resolving to bounding boxes, in request order

Since

SDK 1.8.0 Protocol 0.7.0

getEntityBoundsById()

getEntityBoundsById(id): Promise<BoundingBox>

Queries the axis-aligned bounding box for a single entity by ID. For bulk lookups, prefer getEntitiesBoundsByIds().

Parameters

Parameter	Type	Description
`id`	`SketchupId`	The entity’s SketchupId

Returns

Promise<BoundingBox>

A promise resolving to the entity’s bounding box

Since

SDK 1.8.0 Protocol 0.7.0

getFacesAreas()

getFacesAreas(faces, transformLike?): Promise<[Face | FaceRef, number][]>

Bulk calculates face areas, accounting for openings cut by glued components (like windows or doors). More accurate than Face.area when components cut openings.

Parameters

Parameter	Type	Description
`faces`	(`Face` \| `FaceRef`)[]	Array of faces or face references
`transformLike?`	`TransformationLike`	Optional transformation to apply

Returns

Promise<[Face | FaceRef, number][]>

Array of [face, area in square inches] pairs

Since

SDK 2.25.0 Protocol 1.22.0

getFaceUVs()

getFaceUVs(requests): Promise<FaceBulkResponse>

Bulk calculates UV texture coordinates for multiple faces and points. Much faster than calling Face.getUVs() repeatedly.

Parameters

Parameter	Type	Description
`requests`	`FaceBulkRequest`	Array of [face, UV request] pairs

Returns

Promise<FaceBulkResponse>

Array of [face, UV response] pairs

Since

SDK 2.25.0 Protocol 1.22.0

getMaterials()

getMaterials(): Promise<Materials>

Queries all materials defined in the model. The returned Materials collection provides fast lookups by name or ID and lets you iterate over all materials.

Returns

Promise<Materials>

A promise resolving to the materials collection

Since

SDK 2.30.0

getNumberOfFaces()

getNumberOfFaces(): Promise<number>

Counts the total number of faces in the model, including faces inside component instances (expanded count). This matches the count shown in SketchUp’s Entity Info.

Returns

Promise<number>

A promise resolving to the total face count

Since

SDK 2.30.0

getRenderingOptions()

getRenderingOptions(): Promise<RenderingOptions>

Queries the rendering options (edge display, materials, transparency, X-ray mode, etc.) that control how SketchUp displays the model.

Returns

Promise<RenderingOptions>

A promise resolving to the rendering options

Since

SDK 2.24.0 Protocol 1.21.0

getScenes()

getScenes(options?): Promise<Scene[]>

Queries all scenes (saved camera positions and settings) in the model. Scenes appear as tabs in SketchUp and can be animated or exported.

Parameters

Parameter	Type	Description
`options?`	`EntityQuery`	Optional filter to apply to the list

Returns

Promise<Scene[]>

A promise resolving to the array of scenes

Since

SDK 2.29.0 Protocol 1.7.0

getSelectedStyle()

getSelectedStyle(): Promise<SelectedStyle>

Queries the currently active style and its info (name, whether it’s been modified, etc.). This is the style applied to the model.

Returns

Promise<SelectedStyle>

A promise resolving to the selected style

Since

SDK 2.26.0 Protocol 1.23.0

getSelection()

getSelection(options?): Promise<Selection>

Queries the entities currently selected in SketchUp. You can optionally filter the selection server-side (e.g., only faces) to reduce data transfer.

Parameters

Parameter	Type	Description
`options?`	`EntityQuery`<`EntityFilter`> \| `SketchupEntityFilter`	Optional filter to apply server-side

Returns

Promise<Selection>

A promise resolving to the selection

Since

SDK 2.14.0 Protocol 1.11.0

getSelectionMetadata()

getSelectionMetadata(options?): Promise<SelectionMetadata>

Queries selection metadata (count, flags) without fetching the actual entity snapshots. Much faster than getSelection() when you only need to know what’s selected, not the full entities.

Parameters

Parameter	Type	Description
`options?`	`EntityQuery`<`EntityFilter`> \| `SketchupEntityFilter`	Optional filter to apply server-side

Returns

Promise<SelectionMetadata>

A promise resolving to the selection metadata

Since

SDK 2.14.0 Protocol 1.11.0

getShadowInfo()

getShadowInfo(): Promise<ShadowInfo>

Queries the model’s shadow settings (time, date, location, shadow display state). Used to control how SketchUp renders shadows and sunlight.

Returns

Promise<ShadowInfo>

A promise resolving to the shadow info

getSkp()

getSkp(options?): Promise<string>

Exports the model as a .skp file and returns it as a base64-encoded data URL. You can write this to disk, send it over a network, or trigger a browser download.

Parameters

Parameter	Type	Description
`options?`	{ `force`: `boolean`; }	Pass `{ force: true }` to save unsaved models with a temporary name
`options.force?`	`boolean`	‐

Returns

Promise<string>

A data URL: data:application/vnd.sketchup.skp;base64,...

Since

SDK 2.30.3 Protocol 1.8.0

getStyles()

getStyles(options?): Promise<Style[]>

Queries all styles available in the model. Styles control edge, face, and background rendering settings.

Parameters

Parameter	Type	Description
`options?`	`EntityQuery`<`EntityFilter`> \| `SketchupEntityFilter`	Optional filter to apply

Returns

Promise<Style[]>

A promise resolving to the array of styles

Since

SDK 2.26.0 Protocol 1.23.0

getTagManager()

getTagManager(): Promise<TagManager>

Queries the tag manager, which provides access to all tags (formerly called layers) and the active tag. Tags control visibility and can be assigned to entities.

Returns

Promise<TagManager>

A promise resolving to the tag manager

invertSelection()

invertSelection(): Promise<SelectionMetadata>

Inverts the selection within the current editing context: previously selected entities become unselected and vice versa. This only affects entities in the current active path. Not an undo-able operation.

Returns

Promise<SelectionMetadata>

Metadata for the selection after inversion

Since

SDK 2.14.0 Protocol 1.11.0

observeActivePath()

observeActivePath(callback): ObserverHandle

Subscribes to changes in the active editing context. Your callback fires immediately with the current path, then again whenever the user double-clicks into or out of a group or component.

Parameters

Parameter	Type	Description
`callback`	(`activePath`) => `void`	Called with the new active path

Returns

ObserverHandle

An observer handle; call .close() to unsubscribe

Since

SDK 2.30.0 Protocol 1.14.0

observeOptionsChanges()

observeOptionsChanges(callback): ObserverHandle

Subscribes to changes in the model’s options (units, location, etc.). Your callback fires whenever the user changes a setting.

Parameters

Parameter	Type	Description
`callback`	(`options`) => `void`	Called with the updated options

Returns

ObserverHandle

An observer handle; call .close() to unsubscribe

Since

SDK 2.30.0

observeRenderingOptions()

observeRenderingOptions(callback): ObserverHandle

Subscribes to changes in the rendering options. Your callback fires whenever the user toggles edges, materials, or other display settings.

Parameters

Parameter	Type	Description
`callback`	(`data`) => `void`	Called with the change event

Returns

ObserverHandle

An observer handle; call .close() to unsubscribe

Since

SDK 2.30.0 Protocol 1.21.0

observeSelectionMetadata()

observeSelectionMetadata(callback, options?): ObserverHandle

Subscribes to changes in the selection. For performance, only metadata (count, flags) is sent. If you need the actual entities, call getSelection() on the metadata object.

Parameters

Parameter	Type	Description
`callback`	(`options`) => `void`	Called with updated selection metadata
`options?`	`EntityQuery`<`EntityFilter`> \| `SketchupEntityFilter`	Optional server-side filter

Returns

ObserverHandle

An observer handle; call .close() to unsubscribe

Since

SDK 2.30.0 Protocol 1.11.0

performOperation()

performOperation<T>(instructions, name, options?): Promise<T>

Performs a named, undo-able operation on the model. All modifications to the model (adding entities, editing geometry, changing materials) must occur within an operation. If the instructions function throws, the operation is automatically aborted and the model is rolled back.

Note that if the operation makes no changes, the model’s revision number will not increment.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`instructions`	(`operation`) => `T` \| `Promise`<`T`>	Sync or async function that performs the changes
`name`	`string`	Name shown in SketchUp’s undo stack
`options?`	`OperationOptions`	Optional operation settings

Returns

Promise<T>

A promise resolving to the value your instructions return

redo()

redo(): Promise<void>

Re-does the most recently undone operation. Equivalent to the user pressing Cmd+Shift+Z (Mac) or Ctrl+Y (Windows).

Returns

Promise<void>

A promise that resolves when the redo completes

Since

SDK 1.7.0 Protocol 0.6.0

refresh()

refresh(): Promise<Model>

Re-fetches a fresh snapshot of this model. The new snapshot will have an updated revision number if the model has changed since you last retrieved it. Use this after operations or when you suspect the user has modified the model.

Returns

Promise<Model>

A promise resolving to a new model snapshot

Example

let model = await SketchUpApi.getActiveModel();
await model.performOperation(
  () => {},
  'Modify the model'
);
let updated = await model.refresh();
console.log(updated.revision);

setCurrentScene()

setCurrentScene(scene): Promise<void>

Activates the specified scene, switching the camera and settings to match that scene’s saved state. This is a view operation and does not require an operation wrapper.

Parameters

Parameter	Type	Description
`scene`	`Scene` \| `SceneRef`	The scene to activate

Returns

Promise<void>

Since

SDK 2.29.0 Protocol 1.7.0

startOperation()

startOperation(name, options?): Promise<Operation>

Starts an operation manually, requiring you to call commit() or abort() explicitly. Prefer performOperation() instead — it handles commit/abort automatically and is safer.

Note that only one operation can be open at a time.

Parameters

Parameter	Type	Description
`name`	`string`	Name shown in SketchUp’s undo stack
`options?`	`OperationOptions`	Optional operation settings

Returns

Promise<Operation>

A promise resolving to the operation handle

See

Model.performOperation for the recommended approach
Operation.commit
Operation.abort

toString()

toString(): string

Returns

string

undo()

undo(): Promise<void>

Undoes the most recent operation in the model’s undo stack. Equivalent to the user pressing Cmd+Z (Mac) or Ctrl+Z (Windows).

Returns

Promise<void>

A promise that resolves when the undo completes

Since

SDK 1.7.0 Protocol 0.6.0

updateRenderingOptions()

updateRenderingOptions(update): Promise<void>

Updates one or more rendering options. If any key or value is invalid, this throws an error — but other valid updates in the same call will have already been applied.

Parameters

Parameter	Type	Description
`update`	`RenderingOptionsUpdate`	Key-value pairs of rendering options to update

Returns

Promise<void>

Since

SDK 2.24.0 Protocol 1.21.0

Throws

Error if any key or value is invalid

updateSelection()

updateSelection(drawingElements, updateType): Promise<SelectionMetadata>

Changes which entities are selected in SketchUp. Pass 'add' to extend the current selection, 'remove' to deselect specific entities, 'replace' to clear everything and select only the given entities, or 'toggle' to flip each entity’s selected state. This is not an undo-able operation — it directly modifies the UI selection.

Parameters

Parameter	Type
`drawingElements`	`DrawingElement` \| `DrawingElementRef` \| readonly `DrawingElement`[] \| readonly `DrawingElementRef`[] \| readonly DrawingElement \| DrawingElementRef[]
`updateType`	`"toggle"` \| `"add"` \| `"replace"` \| `"remove"`

Returns

Promise<SelectionMetadata>

Metadata for the selection after the update

Since

SDK 2.14.0 Protocol 1.11.0

Show Deprecated

Deprecated

bounds

Get Signature

get bounds(): Promise<BoundingBox>

Since

SDK 1.8.0 Protocol 0.7.0

Returns

Promise<BoundingBox>

classifications

Get Signature

get classifications(): Promise<readonly ClassificationSchema[]>

Since

SDK 2.5.0 Protocol 1.3.0

Returns

Promise<readonly ClassificationSchema[]>

activeSectionPlanes()

activeSectionPlanes(filter?): Promise<readonly SectionPlane[]>

Query to find only the active section planes (protocol)

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	when provided, filters the list of active section planes

Returns

Promise<readonly SectionPlane[]>

a promise containing a snapshot of the active section planes

Since

SDK 2.16.0 Protocol 1.13.0

componentInstances()

componentInstances(filter?): Promise<readonly ComponentInstance[]>

Typesafe query to get all the component instances at the root of the model

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	optional additional filtering to apply

Returns

Promise<readonly ComponentInstance[]>

a promise containing the array of component instances

See

Model.entities

components()

components(): Promise<readonly ComponentDefinition[]>

Query to get all the component (definitions) in the model

Returns

Promise<readonly ComponentDefinition[]>

a promise containing the components

constructionLines()

constructionLines(filter?): Promise<readonly ConstructionLine[]>

Query to find the constructionLines

Parameters

Parameter	Type	Default value
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`

Returns

Promise<readonly ConstructionLine[]>

a promise containing a snapshot of the constructionLines

Since

SDK 2.7.0 Protocol 1.5.0

constructionPoints()

constructionPoints(filter?): Promise<readonly ConstructionPoint[]>

Query to find the constructionPoints

Parameters

Parameter	Type	Default value
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`

Returns

Promise<readonly ConstructionPoint[]>

a promise containing a snapshot of the constructionPoints

Since

SDK 2.7.0 Protocol 1.5.0

currentMaterial()

currentMaterial(): Promise<Material | undefined>

Returns

Promise<Material | undefined>

curves()

curves(filter?): Promise<readonly (ArcCurve | Curve)[]>

Gets the curves for root of this model

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	optional filter to apply to the list of curves

Returns

Promise<readonly (ArcCurve | Curve)[]>

Since

SDK 2.23.0 Protocol 1.20.0

dimensionLinears()

dimensionLinears(filter?): Promise<readonly DimensionLinear[]>

Query to find the dimension linear entities for this group

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	optional additional filtering to apply

Returns

Promise<readonly DimensionLinear[]>

a promise containing a snapshot of the dimension linear entities for this group

Since

SDK 2.23.0 Protocol 1.20.0

dimensionRadials()

dimensionRadials(filter?): Promise<readonly DimensionRadial[]>

Query to find the dimension radial entities for this group

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	optional additional filtering to apply

Returns

Promise<readonly DimensionRadial[]>

a promise containing a snapshot of the dimension radial entities for this group

Since

SDK 2.23.0 Protocol 1.20.0

edges()

edges(filter?): Promise<readonly Edge[]>

Typesafe query to get all the edges at the root of the model

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	optional additional filtering to apply

Returns

Promise<readonly Edge[]>

a promise containing the array of edges

See

Model.entities

export()

export(options?): Promise<string>

Parameters

Parameter	Type
`options?`	{ `force`: `boolean`; }
`options.force?`	`boolean`

Returns

Promise<string>

Since

SDK 2.11.0 Protocol 1.8.0

faces()

faces(filter?): Promise<readonly Face[]>

Typesafe query to get all the faces at the root of the model

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	optional additional filtering to apply

Returns

Promise<readonly Face[]>

a promise containing the array of faces

See

Model.entities

findCurvesForEdges()

findCurvesForEdges(edges): Promise<(ArcCurve | Curve)[]>

Parameters

Parameter	Type
`edges`	readonly (`Edge` \| `EdgeRef`)[]

Returns

Promise<(ArcCurve | Curve)[]>

findEntitiesById()

findEntitiesById(ids): Promise<(Entity | undefined)[]>

Query to find an entities by an array of ids

Parameters

Parameter	Type	Description
`ids`	readonly `SketchupId`[]	the array of entity ids

Returns

Promise<(Entity | undefined)[]>

a promise with an array or entities in the order requested. If an entity is not found the array entry will be undefined.

findEntityById()

findEntityById(id): Promise<Entity | undefined>

Query to find an entity by id

Parameters

Parameter	Type	Description
`id`	`SketchupId`	the entity id

Returns

Promise<Entity | undefined>

a promise with the entity, or undefined if no matching entity was found

findEntityWithTypeById()

findEntityWithTypeById<Type>(id, expectedType): Promise<EntityFromSketchupEntityEnum<Type> | undefined>

Utility to find an entity and validate the type. Usually called internally.

Type Parameters

Type Parameter
`Type` extends `EntityType`

Parameters

Parameter	Type	Description
`id`	`SketchupId`	the entity id
`expectedType`	`Type`	the expected type of the entity

Returns

Promise<EntityFromSketchupEntityEnum<Type> | undefined>

a promise with the entity or undefined

Throws

Error if the type of the entity from SketchUp does not match the expected type

getActiveSectionPlane()

getActiveSectionPlane(): Promise<SectionPlane | undefined>

Gets the active section plane for the given entities container.

Returns

Promise<SectionPlane | undefined>

A promise resolving to the SectionPlaneRef or undefined if none is active

Since

SDK 2.16.0 Protocol 1.13.0

groups()

groups(filter?): Promise<readonly Group[]>

Typesafe query to get all the groups at the root of the model

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	optional additional filtering to apply

Returns

Promise<readonly Group[]>

a promise containing the array of groups

See

Model.entities

images()

images(filter?): Promise<readonly ImageEntity[]>

Query to find the images at the root of this model

Parameters

Parameter	Type	Default value	Description
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`	optional additional filtering to apply

Returns

Promise<readonly ImageEntity[]>

a promise containing a snapshot of the images for this model

Since

SDK 2.21.0 Protocol 1.18.0

materials()

materials(): Promise<Materials>

Returns

Promise<Materials>

numberOfFaces()

numberOfFaces(): Promise<number>

Returns

Promise<number>

sectionPlanes()

sectionPlanes(filter?): Promise<readonly SectionPlane[]>

Query to find the sectionPlanes

Parameters

Parameter	Type	Default value
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`

Returns

Promise<readonly SectionPlane[]>

a promise containing a snapshot of the sectionPlanes

Since

SDK 2.16.0 Protocol 1.13.0

snaps()

snaps(filter?): Promise<readonly Snap[]>

Query to find the snaps

Parameters

Parameter	Type	Default value
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`

Returns

Promise<readonly Snap[]>

a promise containing a snapshot of the snaps

Since

SDK 2.20.0 Protocol 1.17.0

streamActivePath()

streamActivePath(callback): ObserverHandle

Streams changes to the active path on the current model

Parameters

Parameter Type Description

callback

(activePath) => void

callback that gets invoked whenever the active path changes.

NOTE: This will be invoked immediately

Returns

ObserverHandle

a closable stream handle

Since

SDK 2.17.0 Protocol 1.14.0

streamOptionsChanges()

streamOptionsChanges(callback): ObserverHandle

Stream the changes to the model options

Parameters

Parameter	Type	Description
`callback`	(`options`) => `void`	invoked whenever there is a change to the options in the model

Returns

ObserverHandle

a stream handle, used to cancel the stream.

streamRenderingOptions()

streamRenderingOptions(callback): ObserverHandle

Streams changes to the rendering options associated with this model

Parameters

Parameter	Type
`callback`	(`data`) => `void`

Returns

ObserverHandle

Since

SDK 2.24.0 Protocol 1.21.0

streamSelectionMetadata()

streamSelectionMetadata(callback, options?): ObserverHandle

Streams changes to the selection metadata in SketchUp.

NOTE this does not give you direct access to the selected entities for performance reasons. If you need to pull all the selected entities based on this metadata change, call getSelection on the metadata object

Parameters

Parameter	Type	Description
`callback`	(`options`) => `void`	callback invoked when there is a change to the selection.
`options?`	`EntityQuery`<`EntityFilter`> \| `SketchupEntityFilter`	when supplied this provides server side filtering to the values returned to the client

Returns

ObserverHandle

The stream handle, used to cancel the stream

Since

SDK 2.14.0 Protocol 1.11.0

texts()

texts(filter?): Promise<readonly Text[]>

Query to find the texts

Parameters

Parameter	Type	Default value
`filter`	`SketchupEntityFilter` \| `undefined`	`undefined`

Returns

Promise<readonly Text[]>

a promise containing a snapshot of the texts

Since

SDK 2.22.0 Protocol 1.19.0