RenderingOptionsData
The complete set of visual display settings for a SketchUp model.
This interface describes every rendering option SketchUp exposes — background colors, edge styles, fog, transparency, section cuts, and more. The RenderingOptions class implements this interface and provides methods to read and stream changes.
Property names match SketchUp’s internal option keys exactly, which is why they use PascalCase rather than the API’s usual camelCase.
Example
Section titled “Example”let model = await SketchUpApi.getActiveModel();let opts = await model.getRenderingOptions();console.log(opts.BackgroundColor.toHex());// => "#CCCCC9FF"console.log(opts.EdgeDisplayMode);// => 1 (EdgeDisplayMode.All)Properties
Section titled “Properties”AmbientOcclusion
Section titled “AmbientOcclusion”AmbientOcclusion:
boolean
AmbientOcclusionColor?
Section titled “AmbientOcclusionColor?”
optionalAmbientOcclusionColor?:Color
AmbientOcclusionDistance
Section titled “AmbientOcclusionDistance”AmbientOcclusionDistance:
number
AmbientOcclusionIntensity
Section titled “AmbientOcclusionIntensity”AmbientOcclusionIntensity:
number
AmbientOcclusionMultiplier?
Section titled “AmbientOcclusionMultiplier?”
optionalAmbientOcclusionMultiplier?:number
BackgroundColor
Section titled “BackgroundColor”BackgroundColor:
Color
BandColor
Section titled “BandColor”BandColor:
Color
ConstructionColor
Section titled “ConstructionColor”ConstructionColor:
Color
DepthQueWidth
Section titled “DepthQueWidth”DepthQueWidth:
number
DisplayColorByLayer
Section titled “DisplayColorByLayer”DisplayColorByLayer:
boolean
DisplayDims
Section titled “DisplayDims”DisplayDims:
boolean
DisplayFog
Section titled “DisplayFog”DisplayFog:
boolean
DisplayInstanceAxes
Section titled “DisplayInstanceAxes”DisplayInstanceAxes:
boolean
DisplaySectionCuts
Section titled “DisplaySectionCuts”DisplaySectionCuts:
boolean
DisplaySectionPlanes
Section titled “DisplaySectionPlanes”DisplaySectionPlanes:
boolean
DisplaySketchAxes
Section titled “DisplaySketchAxes”DisplaySketchAxes:
boolean
DisplayText
Section titled “DisplayText”DisplayText:
boolean
DisplayWatermarks
Section titled “DisplayWatermarks”DisplayWatermarks:
boolean
DrawBackEdges
Section titled “DrawBackEdges”DrawBackEdges:
boolean
DrawDepthQue
Section titled “DrawDepthQue”DrawDepthQue:
boolean
DrawGround
Section titled “DrawGround”DrawGround:
boolean
DrawHidden
Section titled “DrawHidden”DrawHidden:
boolean
DrawHorizon
Section titled “DrawHorizon”DrawHorizon:
boolean
DrawLineEnds
Section titled “DrawLineEnds”DrawLineEnds:
boolean
DrawProfilesOnly
Section titled “DrawProfilesOnly”DrawProfilesOnly:
boolean
DrawSilhouettes
Section titled “DrawSilhouettes”DrawSilhouettes:
boolean
DrawUnderground
Section titled “DrawUnderground”DrawUnderground:
boolean
EdgeColorMode
Section titled “EdgeColorMode”EdgeColorMode:
EdgeColorMode
EdgeDisplayMode
Section titled “EdgeDisplayMode”EdgeDisplayMode:
EdgeDisplayMode
EdgeType
Section titled “EdgeType”EdgeType:
EdgeType
ExtendLines
Section titled “ExtendLines”ExtendLines:
boolean
FaceBackColor
Section titled “FaceBackColor”FaceBackColor:
Color
FaceFrontColor
Section titled “FaceFrontColor”FaceFrontColor:
Color
FogColor
Section titled “FogColor”FogColor:
Color
FogEndDist
Section titled “FogEndDist”FogEndDist:
number
FogStartDist
Section titled “FogStartDist”FogStartDist:
number
FogUseBkColor
Section titled “FogUseBkColor”FogUseBkColor:
boolean
ForegroundColor
Section titled “ForegroundColor”ForegroundColor:
Color
GroundColor
Section titled “GroundColor”GroundColor:
Color
GroundTransparency
Section titled “GroundTransparency”GroundTransparency:
number
HideConstructionGeometry
Section titled “HideConstructionGeometry”HideConstructionGeometry:
boolean
HighlightColor
Section titled “HighlightColor”HighlightColor:
Color
HorizonColor
Section titled “HorizonColor”HorizonColor:
Color
InactiveFade
Section titled “InactiveFade”InactiveFade:
number
InactiveHidden
Section titled “InactiveHidden”InactiveHidden:
boolean
InstanceFade
Section titled “InstanceFade”InstanceFade:
number
InstanceHidden
Section titled “InstanceHidden”InstanceHidden:
boolean
JitterEdges
Section titled “JitterEdges”JitterEdges:
boolean
LineEndWidth
Section titled “LineEndWidth”LineEndWidth:
number
LineExtension
Section titled “LineExtension”LineExtension:
number
LockedColor
Section titled “LockedColor”LockedColor:
Color
MaterialTransparency
Section titled “MaterialTransparency”MaterialTransparency:
boolean
ModelTransparency
Section titled “ModelTransparency”ModelTransparency:
boolean
RenderMode
Section titled “RenderMode”RenderMode:
RenderMode
SectionActiveColor
Section titled “SectionActiveColor”SectionActiveColor:
Color
SectionCutDrawEdges
Section titled “SectionCutDrawEdges”SectionCutDrawEdges:
boolean
SectionCutFilled
Section titled “SectionCutFilled”SectionCutFilled:
boolean
SectionCutWidth
Section titled “SectionCutWidth”SectionCutWidth:
number
SectionDefaultCutColor
Section titled “SectionDefaultCutColor”SectionDefaultCutColor:
Color
SectionDefaultFillColor
Section titled “SectionDefaultFillColor”SectionDefaultFillColor:
Color
SectionInactiveColor
Section titled “SectionInactiveColor”SectionInactiveColor:
Color
ShowViewName
Section titled “ShowViewName”ShowViewName:
boolean
SilhouetteWidth
Section titled “SilhouetteWidth”SilhouetteWidth:
number
SkyColor
Section titled “SkyColor”SkyColor:
Color
Texture
Section titled “Texture”Texture:
boolean
TransparencySort
Section titled “TransparencySort”TransparencySort:
TransparencySort