Platform

Information about the SketchUp platform the extension is running on — desktop, web, or iPad.

Access it from SketchUpApi.platform after connecting. Use it to write platform-specific code or gate features on the SketchUp version.

Example

let { platform } = SketchUpApi;

console.log(platform.platform);
// => 'WEB', 'Desktop', or 'iPad'
console.log(platform.isDesktop);
// => false (on web)
console.log(platform.majorVersion);
// => 2026

See

Sketchup.platform

Properties

majorVersion

readonly majorVersion: number

The parsed major version number, like 2026.

platform

readonly platform: string

The platform identifier — 'WEB', 'Desktop', 'DesktopRuby', or 'iPad'.

platformFeatures

readonly platformFeatures: string[]

The list of feature flags enabled for this platform.

SketchUpVersion

readonly SketchUpVersion: Version

The full semantic version as a Version object — useful for comparing against a minimum required version.

version

readonly version: string

The SketchUp version string, like '2026.0'.

Accessors

isDesktop

Get Signature

get isDesktop(): boolean

true when running inside SketchUp Desktop (Windows or Mac).

Returns

boolean

isIpad

Get Signature

get isIpad(): boolean

true when running inside SketchUp for iPad.

Returns

boolean

isWeb

Get Signature

get isWeb(): boolean

true when running inside SketchUp Web (the browser app).

Returns

boolean

supportsAmbientOcclusionColor

Get Signature

get supportsAmbientOcclusionColor(): boolean

true if the ambient occlusion color property is supported. Requires Desktop 2026 or later; always true on web and iPad.

Returns

boolean

supportsConsistentUndoRevisions

Get Signature

get supportsConsistentUndoRevisions(): boolean

true if undo history is consistent between operations. false on DesktopRuby where the Ruby backend handles undo.

Returns

boolean

supportsCreateDuplicateStyle

Get Signature

get supportsCreateDuplicateStyle(): boolean

true if styles can be duplicated. Requires Desktop 26.2.0 or later; always true on web and iPad.

Returns

boolean

supportsCRSLocation

Get Signature

get supportsCRSLocation(): boolean

true if CRS (Coordinate Reference System) location is supported on this platform.

Returns

boolean

supportsPBR

Get Signature

get supportsPBR(): boolean

true if physically-based rendering (PBR) is available. Requires SketchUp Desktop 2025 or later; always true on web and iPad.

Returns

boolean

supportsRemoveStyle

Get Signature

get supportsRemoveStyle(): boolean

true if styles can be removed. Requires Desktop 25.1.0 or later; always true on web and iPad.

Returns

boolean

supportsSceneGetActiveSectionPlanes

Get Signature

get supportsSceneGetActiveSectionPlanes(): boolean

true if scene.getActiveSectionPlanes() is supported. Requires Desktop 2026 or later; always true on web and iPad.

Returns

boolean

supportsSceneReordering

Get Signature

get supportsSceneReordering(): boolean

true if scenes can be reordered. Requires Desktop 2025 or later; always true on web and iPad.

Returns

boolean

supportsScreenshotRenderOptions

Get Signature

get supportsScreenshotRenderOptions(): boolean

true if screenshot render options (like scale) are supported. false on DesktopRuby.

Returns

boolean

supportsSnaps

Get Signature

get supportsSnaps(): boolean

true if snap-point queries are supported. Requires Desktop 2025 or later; always true on web and iPad.

Returns

boolean

uniqueSceneNames

Get Signature

get uniqueSceneNames(): boolean

true if scene names must be unique. Requires Desktop 2026 or later; always true on web and iPad.

Returns

boolean

Methods

ensureSupportsPBR()

ensureSupportsPBR(): void

Throws if PBR is not supported on this platform and version. Use before calling PBR-related API methods.

Returns

void

supportsColorizedImageType()

supportsColorizedImageType(dataType): dataType is ImageFileType

Returns true if the given image format is supported for colorized screenshots. JPEG is not supported on SketchUp Web.

Parameters

Parameter	Type	Description
`dataType`	`string`	image format string, e.g. `'png'` or `'jpg'`

Returns

dataType is ImageFileType

supportsImageType()

supportsImageType(dataType): dataType is ImageFileType

Returns true if the given image format is supported for screenshots. GIF is not supported on SketchUp Web.

Parameters

Parameter	Type	Description
`dataType`	`string`	image format string, e.g. `'png'` or `'gif'`

Returns

dataType is ImageFileType

toString()

toString(): string

Returns

string

Show Deprecated

Deprecated

isP11

Get Signature

get isP11(): boolean

true when running inside SketchUp Web (the browser app).

Returns

boolean