123456789_123456789_123456789_123456789_123456789_

Class: Sketchup::Page

Relationships
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Entity
Instance Chain:
self, Entity
Inherits: Sketchup::Entity

Overview

The Page class contains methods to extract information and modify the properties of an individual page.

Note that inside the SketchUp user interface pages are called “Scenes”.

Since SketchUp 2026.0, modifying the Axes, Camera, RenderingOptions, and ShadowInfo properties of a page is an undoable operation and should be wrapped between Model#start_operation and Model#commit_operation. Example:

model = Sketchup.active_model
pages = model.pages
origin = Geom::Point3d.new(10, 0, 0)

model.start_operation("Set Page Properties")
page = pages.add("My Page")
page.axes.set(origin, Y_AXIS, X_AXIS, Z_AXIS)
page.camera.fov = 56.78
page.shadow_info["City"] = "Brasov, Romania"
page.rendering_options["BackgroundColor"] = "Pink"
model.commit_operation

Version:

  • SketchUp 6.0

Instance Attribute Summary

Entity - Inherited

#deleted?

The deleted? method is used to determine if your entity is still valid (not deleted by another script, for example.).
#valid?

The #valid? method is used to determine if your entity is still valid (not deleted by another script, for example).

Instance Method Summary

Entity - Inherited

#add_observer

The add_observer method is used to add an observer to the current object.
#attribute_dictionaries

The attribute_dictionaries method is used to retrieve the AttributeDictionaries collection attached to the entity.
#attribute_dictionary

The attribute_dictionary method is used to retrieve an attribute dictionary with a given name that is attached to an Entity.
#delete_attribute

The #delete_attribute method is used to delete an attribute from an entity.
#entityID

The entityID method is used to retrieve a unique ID assigned to an entity.
#get_attribute

The #get_attribute method is used to retrieve the value of an attribute in the entity’s attribute dictionary.
#inspect

The #inspect method is used to retrieve the string representation of the entity.
#model

The model method is used to retrieve the model for the entity.
#parent

The parent method is used to retrieve the parent of the entity.
#persistent_id

The #persistent_id method is used to retrieve a unique persistent id assigned to an entity.
#remove_observer

The remove_observer method is used to remove an observer from the current object.
#set_attribute

The set attribute is used to set the value of an attribute in an attribute dictionary with the given name.
#to_s

The #to_s method is used to retrieve the string representation of the entity.
#typename

The typename method retrieves the type of the entity, which will be a string such as “Face”, “Edge”, or “Group”.

Instance Attribute Details

#delay_time ⇒ Object (rw)

The delay_time method retrieves the amount of time, in seconds, that a page will be displayed before transition to another page during a tour.

The default delay time can be modified in the Model Info > Animation panel of the SketchUp User Interface. If this method returns -1, the default delay time is used.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
time = page.delay_time

Returns:

  • time - the number of seconds of delay

Version:

  • SketchUp 6.0

#delay_time=(seconds) ⇒ Object (rw)

The delay_time= method sets the amount of time, in seconds, that a page will be displayed before transitioning to another page during a tour. If you set the delay for a page to be -1, the default delay time will be used.

The default delay time can be modified in the Model Info > Animation panel of the SketchUp User Interface.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
time = page.delay_time = 10

Parameters:

  • seconds —

    The number of seconds to set as the delay time.

Returns:

  • time - the number of seconds of delay

Version:

  • SketchUp 6.0

#description ⇒ Object (rw)

The description method retrieves the description for a page as found in the Scenes manager dialog.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
description = page.description

Returns:

  • description - a textual description for the page.

Version:

  • SketchUp 6.0

#description=(description) ⇒ Object (rw)

The description method sets the description for a page as found in the Scenes manager dialog.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
description = page.description = "This is my first page"

Parameters:

  • description —

    A string description for the page.

Returns:

  • description - the new string description for the page

Version:

  • SketchUp 6.0

#environment ⇒ Sketchup::Environment (rw)

The #environment method is used to retrieve the Environment for the scene.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add('My Page')
page.environment

Version:

  • SketchUp 2025.0

#environment=(environment) ⇒ Sketchup::Environment (rw)

The #environment= method is used to set the Environment for the scene.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add('My Page')
path = 'path/to/environment.hdr'
environment = model.environments.add('My Environment', path)
page.environment = environment

Parameters:

Version:

  • SketchUp 2025.0

#include_in_animation=(include) ⇒ Page (rw)

The #include_in_animation= method controls whether the page should be included when exporting an animation from the model.

Examples:

Turn off animation for all pages.

model = Sketchup.active_model
model.pages.each { |page|
  page.include_in_animation = false
}

Parameters:

  • include (Boolean)

Version:

  • SketchUp 2018

#include_in_animation? ⇒ Boolean (rw)

The #include_in_animation? method determines whether the page should be included when exporting an animation from the model.

Examples:

model = Sketchup.active_model
in_animation = model.pages.select { |page| page.include_in_animation? }

Version:

  • SketchUp 2018

#name ⇒ Object (rw)

The name method retrieves the name for a page from the page tab.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
name = page.name

Returns:

  • label - a string name for the page tab

Version:

  • SketchUp 6.0

#name=(name) ⇒ Object (rw)

The #name= method sets the name for a page’s tab. If the name is already used by another page, a unique name is created.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
name = page.name = "Page Name"

Parameters:

  • name —

    The name of the page to be set.

Returns:

  • name - the name that you have set

Version:

  • SketchUp 6.0

#transition_time ⇒ Object (rw)

Get the amount of time that it takes to transition to this page during a slideshow or animation export. If this value is -1, it means to use the default transition time.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
time = page.transition_time

Returns:

  • transitiontime - the amount of time it takes to transition to this page during a slideshow or animation export.

Version:

  • SketchUp 6.0

#transition_time=(trans_time) ⇒ Object (rw)

The transition_time= method is used to set the transition time.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
time = page.transition_time=20

Parameters:

  • trans_time —

    The transition time in seconds.

Returns:

  • transitiontime - the new transition time

Version:

  • SketchUp 6.0

#use_axes=(pagesettings) ⇒ Object (rw)

The use_axes= method sets the page’s axes property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
# Set use_axes to false
status = page.use_axes=false

Parameters:

  • pagesettings —

    true if you want your page to save this property, false if you do not want your page to save this property.

Returns:

  • status - true if you are saving the property, false if you are not saving the property.

Version:

  • SketchUp 6.0

#use_axes? ⇒ Boolean (rw)

The use_axes? method determines whether you are storing the axes property with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_axes?

Returns:

  • (Boolean) —

    status - true if you are storing the this property with the page, false if you are not storing this property with the page.

Version:

  • SketchUp 6.0

#use_camera=(setting) ⇒ Object (rw)

The use_camera= method sets the page’s camera property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_camera = true

Parameters:

  • setting —

    true if you want your page to save this property, false if you do not want your page to save this property.

Returns:

  • status - true if you are saving the property, false if you are not saving the property.

Version:

  • SketchUp 6.0

#use_camera? ⇒ Boolean (rw)

The use_camera? method determines whether you are storing the camera property with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_camera?

Returns:

  • (Boolean) —

    status - true if you are storing the this property with the page, false if you are not storing this property with the page.

Version:

  • SketchUp 6.0

#use_environment=(use_environment) ⇒ Boolean (rw)

The #use_environment= method is used to set if the Environment settings are used in the scene.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add('My Page')
page.use_environment?
# => true
page.use_environment = false
page.use_environment?
# => false

Parameters:

  • use_environment (Boolean)

Version:

  • SketchUp 2025.0

#use_environment? ⇒ Boolean (rw)

The #use_environment? method is used to determine if the Environment settings are used in the scene.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add('My Page')
page.use_environment?
# => true
page.use_environment = false
page.use_environment?
# => false

Version:

  • SketchUp 2025.0

#use_hidden=(setting) ⇒ Object (rw)

Deprecated.

The functionality is replaced by #use_hidden_geometry= and #use_hidden_objects= in SketchUp 2020.1.

The use_hidden= method sets the page’s hidden property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_hidden = false

Parameters:

  • setting —

    true if you want your page to save this property, false if you do not want your page to save this property.

Returns:

  • status - true if you are saving the property, false if you are not saving the property.

See Also:

Version:

  • SketchUp 6.0

#use_hidden? ⇒ Boolean (rw)

Deprecated.

The functionality is replaced by #use_hidden_geometry? and #use_hidden_objects? in SketchUp 2020.1.

The use_hidden? method determines whether you are storing the hidden property with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden?

Returns:

  • (Boolean) —

    status - true if you are storing the this property with the page, false if you are not storing this property with the page.

See Also:

Version:

  • SketchUp 6.0

#use_hidden_geometry=(setting) (rw)

Sets the page’s use hidden geometry property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden_geometry = false

Parameters:

  • setting (Boolean) —

    true if you want your page to save this property, false if you do not want your page to save this property.

Version:

  • SketchUp 2020.1

#use_hidden_geometry? ⇒ Boolean (rw)

Returns the use hidden geometry property from the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden_geometry?

Version:

  • SketchUp 2020.1

#use_hidden_layers=(setting) ⇒ Object (rw)

The use_hidden_layers= method sets the page’s hidden layers property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_hidden_layers = false

Parameters:

  • setting —

    true if you want your page to save this property, false if you do not want your page to save this property.

Returns:

  • status - true if you are saving the property, false if you are not saving the property.

Version:

  • SketchUp 6.0

#use_hidden_layers? ⇒ Boolean (rw)

The use_hidden_layers? method determines whether you are storing the hidden layers property with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_hidden_layers?

Returns:

  • (Boolean) —

    status - true if you are storing the this property with the page, false if you are not storing this property with the page.

Version:

  • SketchUp 6.0

#use_hidden_objects=(setting) (rw)

Sets the page’s use hidden objects property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden_objects = false

Parameters:

  • setting (Boolean) —

    true if you want your page to save this property, false if you do not want your page to save this property.

Version:

  • SketchUp 2020.1

#use_hidden_objects? ⇒ Boolean (rw)

Returns the use hidden objects property from the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
status = page.use_hidden_objects?

Version:

  • SketchUp 2020.1

#use_rendering_options=(setting) ⇒ Object (rw)

The use_rendering_optoins= method sets the page’s display settings property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_rendering_options = false

Parameters:

  • setting —

    true if you want your page to save this property, false if you do not want your page to save this property.

Returns:

  • status - true if you are saving the property, false if you are not saving the property.

Version:

  • SketchUp 6.0

#use_rendering_options? ⇒ Boolean (rw)

The use_rendering_options? method determines whether you are storing the rendering options property with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_rendering_options?

Returns:

  • (Boolean) —

    status - true if you are storing the this property with the page, false if you are not storing this property with the page.

Version:

  • SketchUp 6.0

#use_section_planes=(setting) ⇒ Object (rw)

The use_section_planes= method sets the page’s section planes property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_section_planes=false

Parameters:

  • setting —

    true if you want your page to save this property, false if you do not want your page to save this property.

Returns:

  • status - true if you are saving the property, false if you are not saving the property.

Version:

  • SketchUp 6.0

#use_section_planes? ⇒ Boolean (rw)

The use_section_planes? method determines whether you are storing the section planes property with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_section_planes?

Returns:

  • (Boolean) —

    status - true if you are storing the this property with the page, false if you are not storing this property with the page.

Version:

  • SketchUp 6.0

#use_shadow_info=(setting) ⇒ Object (rw)

The use_shadow_info= method sets the page’s shadow info property.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_shadow_info=false

Parameters:

  • setting —

    true if you want your page to save this property, false if you do not want your page to save this property.

Returns:

  • status - true if you are saving the property, false if you are not saving the property.

Version:

  • SketchUp 6.0

#use_shadow_info? ⇒ Boolean (rw)

The use_shadow_info? method determines whether you are storing the shadow info property with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.use_shadow_info?

Returns:

  • (Boolean) —

    status - true if you are storing the this property with the page, false if you are not storing this property with the page.

Version:

  • SketchUp 6.0

#use_style=(style) ⇒ Object (rw)

The use_style= method sets the style to be used by the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
style = model.styles[0]
page.use_style = style

Parameters:

  • style —

    The Style object to use.

Returns:

  • nil

Version:

  • SketchUp 6.0

#use_style? ⇒ Boolean (rw)

The use_style? method determines whether storing a style with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
use_style = page.use_style?

Returns:

  • (Boolean) —

    status - true if you are storing the this property with the page, false if you are not storing this property with the page.

Version:

  • SketchUp 6.0

Instance Method Details

#active_section_planes ⇒ Array<Sketchup::SectionPlane>?

The #active_section_planes method is used to retrieve the active section plane for the Page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add('My Page')
page.active_section_planes

Returns:

Version:

  • SketchUp 2026.0

#axes ⇒ Sketchup::Axes

The axes method returns the drawing axes for the page.

Since SketchUp 2026.0, modifying the axes of a scene is an undoable operation.

Examples:

model = Sketchup.active_model
page = model.pages.add("Example Page")
xaxis = Geom::Vector3d.new(3, 5, 0)
yaxis = xaxis * Z_AXIS
page.axes.set([10,0,0], xaxis, yaxis, Z_AXIS)
page.update(PAGE_USE_ALL)
page.axes

Version:

  • SketchUp 2016

#camera ⇒ Sketchup::Camera

The #camera method retrieves the camera for a particular page.

Since SketchUp 2026.0, modifying the camera properties of a scene is an undoable operation.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
camera = page.camera

Version:

  • SketchUp 6.0

#get_drawingelement_visibility(element) ⇒ Boolean

The #get_drawingelement_visibility method is used to get the visibility of a drawing element on a particular page.

Examples:

model = Sketchup.active_model
entities = model.active_entities
point1 = Geom::Point3d.new(10,0,0)
constpoint = entities.add_cpoint(point1)
pages = model.pages
page = pages.add("My Page")
result = page.get_drawingelement_visibility(constpoint)
# SketchUp 2020.1 is required
def element_visible_in_page?(element, page)
  case element
  when Sketchup::ComponentInstance, Sketchup::Group
    return unless page.use_hidden_objects?
  else
    return unless page.use_hidden_geometry?
    return unless element.parent == Sketchup.active_model
  end
  page.get_drawingelement_visibility(element)
end

Parameters:

Returns:

  • (Boolean) —

    • true if visible, false if not.

Version:

  • SketchUp 2020.0

#hidden_entities ⇒ Array<Sketchup::Drawingelement>

The hidden_entities method retrieves all hidden entities within a page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
entities = page.hidden_entities

Returns:

Version:

  • SketchUp 6.0

#label ⇒ Object

The label method retrieves the label for a page from the page tab.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
label = page.label

Returns:

  • label - a string label for the page tab

Version:

  • SketchUp 6.0

#layer_folders ⇒ Array<Sketchup::LayerFolder>?

The #layer_folders method retrieves the hidden layer folders associated with a page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
folders = page.layer_folders

Returns:

Version:

  • SketchUp 2021.0

#layers ⇒ Array<Sketchup::Layer>?

The #layers method retrieves layers that don’t use their default visibility on this page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
layers = page.layers

Test layer visibility

def visible_in_scene?(layer, scene)
  scene.layers.include?(layer) == hidden_by_default?(layer)
end

def hidden_by_default?(layer)
  layer.page_behavior & LAYER_HIDDEN_BY_DEFAULT == LAYER_HIDDEN_BY_DEFAULT
end

Returns:

Version:

  • SketchUp 6.0

#rendering_options ⇒ Sketchup::RenderingOptions

Note:

Most rendering options of a scene are also present in Style and are governed by the selected style. Those options should not be changed from the scene. The ones not related to Style like fog (DisplayFog, FogColor) are safe to be changed from the scene.

The rendering_options method retrieves a RenderingOptions object for the page.

Since SketchUp 2026.0, modifying rendering_options of a scene is an undoable operation.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
renderingoptions = page.rendering_options

Version:

  • SketchUp 6.0

#set_drawingelement_visibility(element, visibility) ⇒ Boolean

The #set_drawingelement_visibility method is used to change the visibility of a drawing element on a particular page. Only drawing elements on the root of the model, as well as nested instances of components, groups, and images are controlled by Page visibility.

Examples:

model = Sketchup.active_model
entities = model.active_entities
point1 = Geom::Point3d.new(10, 0, 0)
constpoint = entities.add_cpoint(point1)
pages = model.pages
page = pages.add("My Page")
page.set_drawingelement_visibility(constpoint, false)

Parameters:

Version:

  • SketchUp 2020.0

#set_visibility(layer, visible_for_page) ⇒ Page #set_visibility(layer_folder, visible_for_page) ⇒ Page

The #set_visibility method sets the visibility for a layer or layer folder on a page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add("My Page")
layer = model.layers.add("My Layer")
page.set_visibility(layer, false)

Overloads:

  • #set_visibility(layer, visible_for_page) ⇒ Page

    Parameters:

  • #set_visibility(layer_folder, visible_for_page) ⇒ Page

    Parameters:

    Version:

    • SketchUp 2021.0

Returns:

  • (Page) —

    the page whose visibility was set.

Version:

  • SketchUp 6.0

#shadow_info ⇒ Sketchup::ShadowInfo

Note:

While certain shadow settings, such as those available in the Shadows panel, can be controlled on a per-page basis, global settings like north angle, latitude, and longitude are managed at the model level and are not page-specific.

The #shadow_info method retrieves the ShadowInfo object for the page.

Since SketchUp 2026.0, modifying shadow_info of a scene is an undoable operation.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
shadowinfo = page.shadow_info

Version:

  • SketchUp 6.0

#style ⇒ Object

The style method retrieves the style associated with the page.

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
style = page.style

Returns:

  • style - the Style object if successful

Version:

  • SketchUp 6.0

#update(flags) ⇒ Boolean

The #update method performs an update on the page properties based on the current view that the user has. What properties of the Page get updated are controlled via an integer whose bits corresponds to different properties. These flags can be used individually or combined using bitwise OR.

PAGE_USE_CAMERA            # Camera Location
PAGE_USE_RENDERING_OPTIONS # Drawing Style
PAGE_USE_SHADOWINFO        # Shadow Setting
PAGE_USE_SKETCHCS          # Axes Location
PAGE_USE_HIDDEN            # Hidden Geometry & Objects (Up 2019 and older)
PAGE_USE_HIDDEN_GEOMETRY   # Hidden Geometry (SU 2020 and later)
PAGE_USE_HIDDEN_OBJECTS    # Hidden Objects (SU 2020 and later)
PAGE_USE_LAYER_VISIBILITY  # Visible Layers
PAGE_USE_SECTION_PLANES    # Active Section Planes
PAGE_USE_ALL               # All possible scene properties
PAGE_USE_ENVIRONMENT       # Environment settings

Examples:

model = Sketchup.active_model
pages = model.pages
page = pages.add "My Page"
status = page.update

# Updates Camera Location, Shadow Settings and Visible Layers.
flags = PAGE_USE_CAMERA | PAGE_USE_SHADOWINFO | PAGE_USE_LAYER_VISIBILITY
status = page.update(flags)

Parameters:

  • flags (Integer) —

    The bitwise OR of the bit flags.

Version:

  • SketchUp 6.0