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
Section titled “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 redawait model.updateRenderingOptions({ SkyColor: '#FF0000',});
// Re-apply the current camera to force// SketchUp to redraw immediatelylet cam = await model.view.getCamera();await model.view.setCamera(cam);- RenderingOptionsData
- RenderMode
- Model.getRenderingOptions
- Model.updateRenderingOptions
- Model.observeRenderingOptions
SDK 2.24.0 Protocol 1.21.0
Implements
Section titled “Implements”Properties
Section titled “Properties”options
Section titled “options”
readonlyoptions:Map<string,AttributeValue>
The raw key-value map of all rendering options from SketchUp.
Accessors
Section titled “Accessors”AmbientOcclusion
Section titled “AmbientOcclusion”Get Signature
Section titled “Get Signature”get AmbientOcclusion():
boolean
Whether ambient occlusion is enabled.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.AmbientOcclusion
AmbientOcclusionColor
Section titled “AmbientOcclusionColor”Get Signature
Section titled “Get Signature”get AmbientOcclusionColor():
Color|undefined
The color tint applied to ambient occlusion shadows. Added in SketchUp 2026.
Returns
Section titled “Returns”Color | undefined
Implementation of
Section titled “Implementation of”RenderingOptionsData.AmbientOcclusionColor
AmbientOcclusionDistance
Section titled “AmbientOcclusionDistance”Get Signature
Section titled “Get Signature”get AmbientOcclusionDistance():
number
The maximum distance at which ambient occlusion is computed.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.AmbientOcclusionDistance
AmbientOcclusionIntensity
Section titled “AmbientOcclusionIntensity”Get Signature
Section titled “Get Signature”get AmbientOcclusionIntensity():
number
The strength of the ambient occlusion effect, from 0 to 1.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.AmbientOcclusionIntensity
AmbientOcclusionMultiplier
Section titled “AmbientOcclusionMultiplier”Get Signature
Section titled “Get Signature”get AmbientOcclusionMultiplier():
number|undefined
A multiplier applied to the ambient occlusion color. Added in SketchUp 2026.
Returns
Section titled “Returns”number | undefined
Implementation of
Section titled “Implementation of”RenderingOptionsData.AmbientOcclusionMultiplier
BackgroundColor
Section titled “BackgroundColor”Get Signature
Section titled “Get Signature”get BackgroundColor():
Color
The sky background color when no sky texture is active.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.BackgroundColor
BandColor
Section titled “BandColor”Get Signature
Section titled “Get Signature”get BandColor():
Color
The color of the horizon band between sky and ground.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.BandColor
ConstructionColor
Section titled “ConstructionColor”Get Signature
Section titled “Get Signature”get ConstructionColor():
Color
The color used to draw construction lines and points.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.ConstructionColor
DepthQueWidth
Section titled “DepthQueWidth”Get Signature
Section titled “Get Signature”get DepthQueWidth():
number
Line width for depth cueing — thicker lines appear closer.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.DepthQueWidth
DisplayColorByLayer
Section titled “DisplayColorByLayer”Get Signature
Section titled “Get Signature”get DisplayColorByLayer():
boolean
Whether entities are colored by their tag instead of their own material.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplayColorByLayer
DisplayDims
Section titled “DisplayDims”Get Signature
Section titled “Get Signature”get DisplayDims():
boolean
Whether dimension entities are shown.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplayDims
DisplayFog
Section titled “DisplayFog”Get Signature
Section titled “Get Signature”get DisplayFog():
boolean
Whether fog is shown in the viewport.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplayFog
DisplayInstanceAxes
Section titled “DisplayInstanceAxes”Get Signature
Section titled “Get Signature”get DisplayInstanceAxes():
boolean
Whether component instance axes are shown.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplayInstanceAxes
DisplaySectionCuts
Section titled “DisplaySectionCuts”Get Signature
Section titled “Get Signature”get DisplaySectionCuts():
boolean
Whether section cut geometry is shown.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplaySectionCuts
DisplaySectionPlanes
Section titled “DisplaySectionPlanes”Get Signature
Section titled “Get Signature”get DisplaySectionPlanes():
boolean
Whether section plane handles are shown in the viewport.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplaySectionPlanes
DisplaySketchAxes
Section titled “DisplaySketchAxes”Get Signature
Section titled “Get Signature”get DisplaySketchAxes():
boolean
Whether the sketch axes are shown in the viewport.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplaySketchAxes
DisplayText
Section titled “DisplayText”Get Signature
Section titled “Get Signature”get DisplayText():
boolean
Whether text entities are shown.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplayText
DisplayWatermarks
Section titled “DisplayWatermarks”Get Signature
Section titled “Get Signature”get DisplayWatermarks():
boolean
Whether watermark images are shown in the viewport.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DisplayWatermarks
DrawBackEdges
Section titled “DrawBackEdges”Get Signature
Section titled “Get Signature”get DrawBackEdges():
boolean
Whether edges behind opaque faces are shown as dashed lines.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawBackEdges
DrawDepthQue
Section titled “DrawDepthQue”Get Signature
Section titled “Get Signature”get DrawDepthQue():
boolean
Whether depth cueing (line width that varies with distance) is enabled.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawDepthQue
DrawGround
Section titled “DrawGround”Get Signature
Section titled “Get Signature”get DrawGround():
boolean
Whether the ground plane is shown.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawGround
DrawHidden
Section titled “DrawHidden”Get Signature
Section titled “Get Signature”get DrawHidden():
boolean
Whether hidden geometry is shown as dashed lines.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawHidden
DrawHorizon
Section titled “DrawHorizon”Get Signature
Section titled “Get Signature”get DrawHorizon():
boolean
Whether the horizon line is shown.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawHorizon
DrawLineEnds
Section titled “DrawLineEnds”Get Signature
Section titled “Get Signature”get DrawLineEnds():
boolean
Whether line endpoints are drawn as dots.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawLineEnds
DrawProfilesOnly
Section titled “DrawProfilesOnly”Get Signature
Section titled “Get Signature”get DrawProfilesOnly():
boolean
Whether only silhouette/profile edges are drawn, hiding interior edges.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawProfilesOnly
DrawSilhouettes
Section titled “DrawSilhouettes”Get Signature
Section titled “Get Signature”get DrawSilhouettes():
boolean
Whether silhouette edges are drawn with a thicker line.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawSilhouettes
DrawUnderground
Section titled “DrawUnderground”Get Signature
Section titled “Get Signature”get DrawUnderground():
boolean
Whether geometry below the ground plane is visible.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.DrawUnderground
EdgeColorMode
Section titled “EdgeColorMode”Get Signature
Section titled “Get Signature”get EdgeColorMode():
EdgeColorMode
How edge colors are determined — by object, foreground, or axis direction.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.EdgeColorMode
EdgeDisplayMode
Section titled “EdgeDisplayMode”Get Signature
Section titled “Get Signature”get EdgeDisplayMode():
EdgeDisplayMode
Which edges are drawn — all, standalone only, or none.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.EdgeDisplayMode
EdgeType
Section titled “EdgeType”Get Signature
Section titled “Get Signature”get EdgeType():
EdgeType
The edge drawing algorithm — standard (crisp) or sketchy (hand-drawn).
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”ExtendLines
Section titled “ExtendLines”Get Signature
Section titled “Get Signature”get ExtendLines():
boolean
Whether lines extend slightly past their endpoints for a hand-drawn look.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.ExtendLines
FaceBackColor
Section titled “FaceBackColor”Get Signature
Section titled “Get Signature”get FaceBackColor():
Color
The default back-face color when no material is applied.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.FaceBackColor
FaceFrontColor
Section titled “FaceFrontColor”Get Signature
Section titled “Get Signature”get FaceFrontColor():
Color
The default front-face color when no material is applied.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.FaceFrontColor
FogColor
Section titled “FogColor”Get Signature
Section titled “Get Signature”get FogColor():
Color
The color of the fog effect.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”FogEndDist
Section titled “FogEndDist”Get Signature
Section titled “Get Signature”get FogEndDist():
number
The distance at which fog reaches full opacity.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.FogEndDist
FogStartDist
Section titled “FogStartDist”Get Signature
Section titled “Get Signature”get FogStartDist():
number
The distance at which fog begins.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.FogStartDist
FogUseBkColor
Section titled “FogUseBkColor”Get Signature
Section titled “Get Signature”get FogUseBkColor():
boolean
Whether fog uses the background color instead of FogColor.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.FogUseBkColor
ForegroundColor
Section titled “ForegroundColor”Get Signature
Section titled “Get Signature”get ForegroundColor():
Color
The edge color used when EdgeColorMode is Foreground.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.ForegroundColor
GroundColor
Section titled “GroundColor”Get Signature
Section titled “Get Signature”get GroundColor():
Color
The color of the ground plane.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.GroundColor
GroundTransparency
Section titled “GroundTransparency”Get Signature
Section titled “Get Signature”get GroundTransparency():
number
Transparency of the ground plane from 0 (opaque) to 100 (fully transparent).
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.GroundTransparency
HideConstructionGeometry
Section titled “HideConstructionGeometry”Get Signature
Section titled “Get Signature”get HideConstructionGeometry():
boolean
Whether construction lines and points are hidden.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.HideConstructionGeometry
HighlightColor
Section titled “HighlightColor”Get Signature
Section titled “Get Signature”get HighlightColor():
Color
The color used to highlight selected entities.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.HighlightColor
HorizonColor
Section titled “HorizonColor”Get Signature
Section titled “Get Signature”get HorizonColor():
Color
The color of the horizon line where sky meets ground.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.HorizonColor
InactiveFade
Section titled “InactiveFade”Get Signature
Section titled “Get Signature”get InactiveFade():
number
Opacity of geometry outside the current edit context, from 0 to 100.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.InactiveFade
InactiveHidden
Section titled “InactiveHidden”Get Signature
Section titled “Get Signature”get InactiveHidden():
boolean
Whether geometry outside the current edit context is hidden entirely.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.InactiveHidden
InstanceFade
Section titled “InstanceFade”Get Signature
Section titled “Get Signature”get InstanceFade():
number
Opacity of component instances outside the current edit context, from 0 to 100.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.InstanceFade
InstanceHidden
Section titled “InstanceHidden”Get Signature
Section titled “Get Signature”get InstanceHidden():
boolean
Whether component instances outside the edit context are hidden.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.InstanceHidden
JitterEdges
Section titled “JitterEdges”Get Signature
Section titled “Get Signature”get JitterEdges():
boolean
Whether edges have a slight random offset for a hand-drawn look.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.JitterEdges
LineEndWidth
Section titled “LineEndWidth”Get Signature
Section titled “Get Signature”get LineEndWidth():
number
Width of line endpoints in pixels when DrawLineEnds is on.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.LineEndWidth
LineExtension
Section titled “LineExtension”Get Signature
Section titled “Get Signature”get LineExtension():
number
How far lines extend past their endpoints in pixels.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.LineExtension
LockedColor
Section titled “LockedColor”Get Signature
Section titled “Get Signature”get LockedColor():
Color
The color used to indicate locked geometry.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.LockedColor
MaterialTransparency
Section titled “MaterialTransparency”Get Signature
Section titled “Get Signature”get MaterialTransparency():
boolean
Whether material transparency is rendered.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.MaterialTransparency
ModelTransparency
Section titled “ModelTransparency”Get Signature
Section titled “Get Signature”get ModelTransparency():
boolean
Whether X-ray (model transparency) mode is enabled.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.ModelTransparency
RenderMode
Section titled “RenderMode”Get Signature
Section titled “Get Signature”get RenderMode():
RenderMode
The face shading style — wireframe, flat, smooth, or PBR.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.RenderMode
SectionActiveColor
Section titled “SectionActiveColor”Get Signature
Section titled “Get Signature”get SectionActiveColor():
Color
The color of active section plane lines.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.SectionActiveColor
SectionCutDrawEdges
Section titled “SectionCutDrawEdges”Get Signature
Section titled “Get Signature”get SectionCutDrawEdges():
boolean
Whether edges are drawn on section cut faces.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.SectionCutDrawEdges
SectionCutFilled
Section titled “SectionCutFilled”Get Signature
Section titled “Get Signature”get SectionCutFilled():
boolean
Whether section cut faces are filled with a solid color.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.SectionCutFilled
SectionCutWidth
Section titled “SectionCutWidth”Get Signature
Section titled “Get Signature”get SectionCutWidth():
number
The line width of section cut edges in pixels.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.SectionCutWidth
SectionDefaultCutColor
Section titled “SectionDefaultCutColor”Get Signature
Section titled “Get Signature”get SectionDefaultCutColor():
Color
The default color of section cut lines.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.SectionDefaultCutColor
SectionDefaultFillColor
Section titled “SectionDefaultFillColor”Get Signature
Section titled “Get Signature”get SectionDefaultFillColor():
Color
The default fill color for section cut faces.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.SectionDefaultFillColor
SectionInactiveColor
Section titled “SectionInactiveColor”Get Signature
Section titled “Get Signature”get SectionInactiveColor():
Color
The color of inactive (non-current) section plane lines.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”RenderingOptionsData.SectionInactiveColor
ShowViewName
Section titled “ShowViewName”Get Signature
Section titled “Get Signature”get ShowViewName():
boolean
Whether the scene/view name is shown in the viewport.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”RenderingOptionsData.ShowViewName
SilhouetteWidth
Section titled “SilhouetteWidth”Get Signature
Section titled “Get Signature”get SilhouetteWidth():
number
The line width for silhouette/profile edges in pixels.
Returns
Section titled “Returns”number
Implementation of
Section titled “Implementation of”RenderingOptionsData.SilhouetteWidth
SkyColor
Section titled “SkyColor”Get Signature
Section titled “Get Signature”get SkyColor():
Color
The sky color shown above the horizon.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Texture
Section titled “Texture”Get Signature
Section titled “Get Signature”get Texture():
boolean
Whether textures are rendered. When false, materials show as flat colors.
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”TransparencySort
Section titled “TransparencySort”Get Signature
Section titled “Get Signature”get TransparencySort():
TransparencySort
The algorithm used to sort overlapping transparent faces.
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”refresh()
Section titled “refresh()”refresh():
Promise<RenderingOptions>
Re-fetches the rendering options from SketchUp to pick up any changes made since this snapshot was taken.
Returns
Section titled “Returns”Promise<RenderingOptions>
toString()
Section titled “toString()”toString():
string
Returns a string representation of an object.
Returns
Section titled “Returns”string