Features

Feature flags for the connected SketchUp session.

As the SketchUp team releases new features for the JavaScript API, we will update this collection. Checking these flags will allow you to support updated capabilities in your extension, while ensuring your users on older versions of SketchUp can be shown friendly error messages, or whatever makes sense.

Access it from SketchUpApi.features after connecting. Each feature corresponds to a minimum protocol version — if the connected SketchUp supports it, the supportsXxx flag is true. Each ensureSupportsXxx() method throws if the feature is unavailable, which you can use to guard API calls.

Example

let { features } = SketchUpApi;

console.log(features.supportsScenes);
// => true
console.log(features.supportsRenderingOptions);
// => true
console.log(features.supportsCRSLocation);
// => true

See

Properties

ensureSupportsActivePath

readonly ensureSupportsActivePath: () => void

Throws if active path is not supported.

Returns

void

ensureSupportsColorizeType

readonly ensureSupportsColorizeType: () => void

Throws if colorize type is not supported.

Returns

void

ensureSupportsCRSLocation

readonly ensureSupportsCRSLocation: () => void

Throws if CRS location is not supported.

Returns

void

ensureSupportsCurves

readonly ensureSupportsCurves: () => void

Throws if curves are not supported.

Returns

void

ensureSupportsDimensions

readonly ensureSupportsDimensions: () => void

Throws if dimensions are not supported.

Returns

void

ensureSupportsFaceUVs

readonly ensureSupportsFaceUVs: () => void

Throws if face UVs are not supported.

Returns

void

ensureSupportsFollowMe

readonly ensureSupportsFollowMe: () => void

Throws if follow-me is not supported.

Returns

void

ensureSupportsImageEntity

readonly ensureSupportsImageEntity: () => void

Throws if image entity is not supported.

Returns

void

ensureSupportsModelExport

readonly ensureSupportsModelExport: () => void

Throws if model export is not supported.

Returns

void

ensureSupportsModifyingModelOptions

readonly ensureSupportsModifyingModelOptions: () => void

Throws if modifying model options is not supported.

Returns

void

ensureSupportsPlaceComponent

readonly ensureSupportsPlaceComponent: () => void

Throws if place component is not supported.

Returns

void

ensureSupportsRenderingOptions

readonly ensureSupportsRenderingOptions: () => void

Throws if rendering options are not supported.

Returns

void

ensureSupportsScenes

readonly ensureSupportsScenes: () => void

Throws if scenes are not supported.

Returns

void

ensureSupportsSectionPlanes

readonly ensureSupportsSectionPlanes: () => void

Throws if section planes are not supported.

Returns

void

ensureSupportsSelection

readonly ensureSupportsSelection: () => void

Throws if selection is not supported.

Returns

void

ensureSupportsSkm

readonly ensureSupportsSkm: () => void

Throws if SKM is not supported.

Returns

void

ensureSupportsSnaps

readonly ensureSupportsSnaps: () => void

Throws if snaps are not supported.

Returns

void

ensureSupportsStyles

readonly ensureSupportsStyles: () => void

Throws if styles are not supported.

Returns

void

ensureSupportsText

readonly ensureSupportsText: () => void

Throws if text is not supported.

Returns

void

ensureSupportsTextures

readonly ensureSupportsTextures: () => void

Throws if textures are not supported.

Returns

void

supportCurves

readonly supportCurves: boolean

true if curve operations are supported (protocol ≥ 1.20.0).

supportsActivePath

readonly supportsActivePath: boolean

true if active path queries are supported (protocol ≥ 1.14.0).

supportsColorAttributes

readonly supportsColorAttributes: boolean

true if color attribute operations are supported.

supportsColorizeType

readonly supportsColorizeType: boolean

true if material colorize type is supported (protocol ≥ 1.12.0).

supportsConstructionPoints

readonly supportsConstructionPoints: boolean

true if construction point queries are supported (protocol ≥ 1.5.0).

supportsCRSLocation

readonly supportsCRSLocation: boolean

true if CRS location operations are supported (protocol ≥ 1.25.0).

supportsDimensions

readonly supportsDimensions: boolean

true if dimension entities are supported.

supportsEvents

readonly supportsEvents: boolean

true if JS Extension events are supported (protocol ≥ 1.24.0).

supportsFaceConnections

readonly supportsFaceConnections: boolean

true if face connection queries are supported.

supportsFaceUVs

readonly supportsFaceUVs: boolean

true if face UV queries are supported (protocol ≥ 1.22.0).

supportsFollowMe

readonly supportsFollowMe: boolean

true if the follow-me tool is supported.

supportsGetArea

readonly supportsGetArea: boolean

true if face area queries are supported.

supportsGlueing

readonly supportsGlueing: boolean

true if gluing operations are supported.

supportsImageEntity

readonly supportsImageEntity: boolean

true if image entity operations are supported (protocol ≥ 1.18.0).

supportsMaterialThumbnails

readonly supportsMaterialThumbnails: boolean

true if material thumbnails are supported.

supportsModelExport

readonly supportsModelExport: boolean

true if model export is supported (protocol ≥ 1.8.0).

supportsModifyingModelOptions

readonly supportsModifyingModelOptions: boolean

true if model options can be modified (protocol ≥ 1.15.0).

supportsPlaceComponent

readonly supportsPlaceComponent: boolean

true if the place-component tool is supported (protocol ≥ 1.16.0).

supportsRenderingOptions

readonly supportsRenderingOptions: boolean

true if rendering option queries are supported (protocol ≥ 1.21.0).

supportsScenes

readonly supportsScenes: boolean

true if scene queries are supported (protocol ≥ 1.7.0).

supportsScreenshotRenderOptions

readonly supportsScreenshotRenderOptions: boolean

true if screenshot render options (scale, etc.) are supported (protocol ≥ 1.25.2).

supportsSectionPlanes

readonly supportsSectionPlanes: boolean

true if section plane operations are supported (protocol ≥ 1.13.0).

supportsSelection

readonly supportsSelection: boolean

true if selection queries are supported (protocol ≥ 1.11.0).

supportsSkm

readonly supportsSkm: boolean

true if SKM material loading is supported.

supportsSnaps

readonly supportsSnaps: boolean

true if snap point queries are supported (protocol ≥ 1.17.0).

supportsStyles

readonly supportsStyles: boolean

true if style operations are supported (protocol ≥ 1.23.0).

supportsTenants

readonly supportsTenants: boolean

true if multi-tenant model access is supported (protocol ≥ 1.10.0).

supportsText

readonly supportsText: boolean

true if text entity operations are supported (protocol ≥ 1.19.0).

supportsTextures

readonly supportsTextures: boolean

true if texture operations are supported (protocol ≥ 1.9.0).

supportsTransparentOperations

readonly supportsTransparentOperations: boolean

true if transparent operation overlays are supported.

supportsVertexPersistentIds

readonly supportsVertexPersistentIds: boolean

true if vertex persistent IDs are supported (protocol ≥ 1.21.1).

Methods

toString()

toString(): string

Returns

string