RenderingOptions

The visual display settings that control how a model looks in the SketchUp viewport.

Use it to read settings like render mode, background color, edge style, fog, and section cut colors. It’s useful for extensions that need to react to display changes — for example, showing a custom overlay only when textures are on, or adjusting UI to match the current render mode.

Get a snapshot with model.getRenderingOptions(). To stay in sync as the user changes display settings, use model.observeRenderingOptions().

Example

let model = await SketchUpApi.getActiveModel();
let opts = await model.getRenderingOptions();

console.log(opts.BackgroundColor.toHex());
// => '#CCCCC9FF'
console.log(opts.RenderMode);
// => 2 (RenderMode.Flat)

// Turn the sky red
await model.updateRenderingOptions({
  SkyColor: '#FF0000',
});

// Re-apply the current camera to force
// SketchUp to redraw immediately
let cam = await model.view.getCamera();
await model.view.setCamera(cam);

See

Since

SDK 2.24.0 Protocol 1.21.0

Implements

RenderingOptionsData

Properties

AmbientOcclusion

readonly AmbientOcclusion: boolean

Whether ambient occlusion is enabled.

Implementation of

RenderingOptionsData.AmbientOcclusion

AmbientOcclusionColor

readonly AmbientOcclusionColor: Color | undefined

The color tint applied to ambient occlusion shadows. Added in SketchUp 2026.

Implementation of

RenderingOptionsData.AmbientOcclusionColor

AmbientOcclusionDistance

readonly AmbientOcclusionDistance: number

The maximum distance at which ambient occlusion is computed.

Implementation of

RenderingOptionsData.AmbientOcclusionDistance

AmbientOcclusionIntensity

readonly AmbientOcclusionIntensity: number

The strength of the ambient occlusion effect, from 0 to 1.

Implementation of

RenderingOptionsData.AmbientOcclusionIntensity

AmbientOcclusionMultiplier

readonly AmbientOcclusionMultiplier: number | undefined

A multiplier applied to the ambient occlusion color. Added in SketchUp 2026.

Implementation of

RenderingOptionsData.AmbientOcclusionMultiplier

BackgroundColor

readonly BackgroundColor: Color

The sky background color when no sky texture is active.

Implementation of

RenderingOptionsData.BackgroundColor

BandColor

readonly BandColor: Color

The color of the horizon band between sky and ground.

Implementation of

RenderingOptionsData.BandColor

ConstructionColor

readonly ConstructionColor: Color

The color used to draw construction lines and points.

Implementation of

RenderingOptionsData.ConstructionColor

DepthQueWidth

readonly DepthQueWidth: number

Line width for depth cueing — thicker lines appear closer.

Implementation of

RenderingOptionsData.DepthQueWidth

DisplayColorByLayer

readonly DisplayColorByLayer: boolean

Whether entities are colored by their tag instead of their own material.

Implementation of

RenderingOptionsData.DisplayColorByLayer

DisplayDims

readonly DisplayDims: boolean

Whether dimension entities are shown.

Implementation of

RenderingOptionsData.DisplayDims

DisplayFog

readonly DisplayFog: boolean

Whether fog is shown in the viewport.

Implementation of

RenderingOptionsData.DisplayFog

DisplayInstanceAxes

readonly DisplayInstanceAxes: boolean

Whether component instance axes are shown.

Implementation of

RenderingOptionsData.DisplayInstanceAxes

DisplaySectionCuts

readonly DisplaySectionCuts: boolean

Whether section cut geometry is shown.

Implementation of

RenderingOptionsData.DisplaySectionCuts

DisplaySectionPlanes

readonly DisplaySectionPlanes: boolean

Whether section plane handles are shown in the viewport.

Implementation of

RenderingOptionsData.DisplaySectionPlanes

DisplaySketchAxes

readonly DisplaySketchAxes: boolean

Whether the sketch axes are shown in the viewport.

Implementation of

RenderingOptionsData.DisplaySketchAxes

DisplayText

readonly DisplayText: boolean

Whether text entities are shown.

Implementation of

RenderingOptionsData.DisplayText

DisplayWatermarks

readonly DisplayWatermarks: boolean

Whether watermark images are shown in the viewport.

Implementation of

RenderingOptionsData.DisplayWatermarks

DrawBackEdges

readonly DrawBackEdges: boolean

Whether edges behind opaque faces are shown as dashed lines.

Implementation of

RenderingOptionsData.DrawBackEdges

DrawDepthQue

readonly DrawDepthQue: boolean

Whether depth cueing (line width that varies with distance) is enabled.

Implementation of

RenderingOptionsData.DrawDepthQue

DrawGround

readonly DrawGround: boolean

Whether the ground plane is shown.

Implementation of

RenderingOptionsData.DrawGround

DrawHidden

readonly DrawHidden: boolean

Whether hidden geometry is shown as dashed lines.

Implementation of

RenderingOptionsData.DrawHidden

DrawHorizon

readonly DrawHorizon: boolean

Whether the horizon line is shown.

Implementation of

RenderingOptionsData.DrawHorizon

DrawLineEnds

readonly DrawLineEnds: boolean

Whether line endpoints are drawn as dots.

Implementation of

RenderingOptionsData.DrawLineEnds

DrawProfilesOnly

readonly DrawProfilesOnly: boolean

Whether only silhouette/profile edges are drawn, hiding interior edges.

Implementation of

RenderingOptionsData.DrawProfilesOnly

DrawSilhouettes

readonly DrawSilhouettes: boolean

Whether silhouette edges are drawn with a thicker line.

Implementation of

RenderingOptionsData.DrawSilhouettes

DrawUnderground

readonly DrawUnderground: boolean

Whether geometry below the ground plane is visible.

Implementation of

RenderingOptionsData.DrawUnderground

EdgeColorMode

readonly EdgeColorMode: EdgeColorMode

How edge colors are determined — by object, foreground, or axis direction.

Implementation of

RenderingOptionsData.EdgeColorMode

EdgeDisplayMode

readonly EdgeDisplayMode: EdgeDisplayMode

Which edges are drawn — all, standalone only, or none.

Implementation of

RenderingOptionsData.EdgeDisplayMode

EdgeType

readonly EdgeType: EdgeType

The edge drawing algorithm — standard (crisp) or sketchy (hand-drawn).

Implementation of

RenderingOptionsData.EdgeType

ExtendLines

readonly ExtendLines: boolean

Whether lines extend slightly past their endpoints for a hand-drawn look.

Implementation of

RenderingOptionsData.ExtendLines

FaceBackColor

readonly FaceBackColor: Color

The default back-face color when no material is applied.

Implementation of

RenderingOptionsData.FaceBackColor

FaceFrontColor

readonly FaceFrontColor: Color

The default front-face color when no material is applied.

Implementation of

RenderingOptionsData.FaceFrontColor

FogColor

readonly FogColor: Color

The color of the fog effect.

Implementation of

RenderingOptionsData.FogColor

FogEndDist

readonly FogEndDist: number

The distance at which fog reaches full opacity.

Implementation of

RenderingOptionsData.FogEndDist

FogStartDist

readonly FogStartDist: number

The distance at which fog begins.

Implementation of

RenderingOptionsData.FogStartDist

FogUseBkColor

readonly FogUseBkColor: boolean

Whether fog uses the background color instead of FogColor.

Implementation of

RenderingOptionsData.FogUseBkColor

ForegroundColor

readonly ForegroundColor: Color

The edge color used when EdgeColorMode is Foreground.

Implementation of

RenderingOptionsData.ForegroundColor

GroundColor

readonly GroundColor: Color

The color of the ground plane.

Implementation of

RenderingOptionsData.GroundColor

GroundTransparency

readonly GroundTransparency: number

Transparency of the ground plane from 0 (opaque) to 100 (fully transparent).

Implementation of

RenderingOptionsData.GroundTransparency

HideConstructionGeometry

readonly HideConstructionGeometry: boolean

Whether construction lines and points are hidden.

Implementation of

RenderingOptionsData.HideConstructionGeometry

HighlightColor

readonly HighlightColor: Color

The color used to highlight selected entities.

Implementation of

RenderingOptionsData.HighlightColor

HorizonColor

readonly HorizonColor: Color

The color of the horizon line where sky meets ground.

Implementation of

RenderingOptionsData.HorizonColor

InactiveFade

readonly InactiveFade: number

Opacity of geometry outside the current edit context, from 0 to 100.

Implementation of

RenderingOptionsData.InactiveFade

InactiveHidden

readonly InactiveHidden: boolean

Whether geometry outside the current edit context is hidden entirely.

Implementation of

RenderingOptionsData.InactiveHidden

InstanceFade

readonly InstanceFade: number

Opacity of component instances outside the current edit context, from 0 to 100.

Implementation of

RenderingOptionsData.InstanceFade

InstanceHidden

readonly InstanceHidden: boolean

Whether component instances outside the edit context are hidden.

Implementation of

RenderingOptionsData.InstanceHidden

JitterEdges

readonly JitterEdges: boolean

Whether edges have a slight random offset for a hand-drawn look.

Implementation of

RenderingOptionsData.JitterEdges

LineEndWidth

readonly LineEndWidth: number

Width of line endpoints in pixels when DrawLineEnds is on.

Implementation of

RenderingOptionsData.LineEndWidth

LineExtension

readonly LineExtension: number

How far lines extend past their endpoints in pixels.

Implementation of

RenderingOptionsData.LineExtension

LockedColor

readonly LockedColor: Color

The color used to indicate locked geometry.

Implementation of

RenderingOptionsData.LockedColor

MaterialTransparency

readonly MaterialTransparency: boolean

Whether material transparency is rendered.

Implementation of

RenderingOptionsData.MaterialTransparency

ModelTransparency

readonly ModelTransparency: boolean

Whether X-ray (model transparency) mode is enabled.

Implementation of

RenderingOptionsData.ModelTransparency

options

readonly options: Map<string, AttributeValue>

The raw key-value map of all rendering options from SketchUp.

RenderMode

readonly RenderMode: RenderMode

The face shading style — wireframe, flat, smooth, or PBR.

Implementation of

RenderingOptionsData.RenderMode

SectionActiveColor

readonly SectionActiveColor: Color

The color of active section plane lines.

Implementation of

RenderingOptionsData.SectionActiveColor

SectionCutDrawEdges

readonly SectionCutDrawEdges: boolean

Whether edges are drawn on section cut faces.

Implementation of

RenderingOptionsData.SectionCutDrawEdges

SectionCutFilled

readonly SectionCutFilled: boolean

Whether section cut faces are filled with a solid color.

Implementation of

RenderingOptionsData.SectionCutFilled

SectionCutWidth

readonly SectionCutWidth: number

The line width of section cut edges in pixels.

Implementation of

RenderingOptionsData.SectionCutWidth

SectionDefaultCutColor

readonly SectionDefaultCutColor: Color

The default color of section cut lines.

Implementation of

RenderingOptionsData.SectionDefaultCutColor

SectionDefaultFillColor

readonly SectionDefaultFillColor: Color

The default fill color for section cut faces.

Implementation of

RenderingOptionsData.SectionDefaultFillColor

SectionInactiveColor

readonly SectionInactiveColor: Color

The color of inactive (non-current) section plane lines.

Implementation of

RenderingOptionsData.SectionInactiveColor

ShowViewName

readonly ShowViewName: boolean

Whether the scene/view name is shown in the viewport.

Implementation of

RenderingOptionsData.ShowViewName

SilhouetteWidth

readonly SilhouetteWidth: number

The line width for silhouette/profile edges in pixels.

Implementation of

RenderingOptionsData.SilhouetteWidth

SkyColor

readonly SkyColor: Color

The sky color shown above the horizon.

Implementation of

RenderingOptionsData.SkyColor

Texture

readonly Texture: boolean

Whether textures are rendered. When false, materials show as flat colors.

Implementation of

RenderingOptionsData.Texture

TransparencySort

readonly TransparencySort: TransparencySort

The algorithm used to sort overlapping transparent faces.

Implementation of

RenderingOptionsData.TransparencySort

Methods

refresh()

refresh(): Promise<RenderingOptions>

Re-fetches the rendering options from SketchUp to pick up any changes made since this snapshot was taken.

Returns

Promise<RenderingOptions>

toString()

toString(): string

Returns a string representation of an object.

Returns

string