Class: Layout::Pages

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/sketchup-api-stubs/stubs/Layout/Pages.rb

Overview

The Pages class is a container class for all pages in a Document.

Examples:

# Grab a handle to an existing LayOut document's pages.
doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages

# From here, we can add pages to or remove them from the document
pages.add("New Page")
pages.remove(pages[0])

Version:

  • LayOut 2018

Instance Method Summary collapse

Instance Method Details

#[](index) ⇒ Layout::Page

The #[] method returns a value from the array of Layout::Pages.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
page = pages[2]

Parameters:

  • index (Integer) —

    The index of the Layout::Page to return.

Returns:

Raises:

  • (IndexError) —

    if index is out of range

Version:

  • LayOut 2018



39
40
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 39

def [](index)
end

#add(name = nil) ⇒ Layout::Page

The #add method adds a new Layout::Page to the Document. The newly added Layout::Page will be the last one in the Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
new_page = doc.add

Parameters:

  • name (String) (defaults to: nil) —

    The name for the new page.

Returns:

Version:

  • LayOut 2018



56
57
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 56

def add(name = nil)
end

#each {|page| ... } ⇒ Object

The #each method iterates through all of the Layout::Pages.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
pages.each { |page|
  puts page.name
}

Yield Parameters:

Version:

  • LayOut 2018



71
72
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 71

def each
end

#index(page) ⇒ Integer?

The #index method returns the index of the Layout::Page, or nil if it doesn’t exist in the Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
page_index = pages.index(pages.first) # Returns 0

Parameters:

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



87
88
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 87

def index(page)
end

#initial ⇒ Layout::Page

The #initial method returns the initial Layout::Page that will be displayed the next time the Document is opened. This value will change whenever the Layout::Page is changed in the Document in LayOut.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
page = pages.initial

Returns:

Version:

  • LayOut 2018



103
104
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 103

def initial
end

#initial=(page) ⇒ Object #initial=(index) ⇒ Object

The #initial= method sets the initial Layout::Page that will be displayed the next time the Document is opened. This value will change whenever the Layout::Page is changed in the Document in LayOut.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
pages.initial = doc.pages[0]

Overloads:

  • #initial=(page) ⇒ Object

    Parameters:

    Raises:

    • (ArgumentError) —

      if page does not belong to the Document

  • #initial=(index) ⇒ Object

    Parameters:

    • index (Integer) —

      The index of the Layout::Page to set as the initial one

    Raises:

    • (IndexError) —

      if index is out of range

Version:

  • LayOut 2018



130
131
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 130

def initial=(page)
end

#length ⇒ Integer Also known as: size

The #length method returns the number of Layout::Pages.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
num_pages = pages.length

Returns:

  • (Integer)

Version:

  • LayOut 2018



143
144
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 143

def length
end

#remove(page) ⇒ Object #remove(index) ⇒ Object

The #remove method deletes the given Layout::Page from the Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
pages.remove(pages[0])

Overloads:

Version:

  • LayOut 2018



173
174
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 173

def remove(page)
end

#reorder(page, new_index) ⇒ Object #reorder(index, new_index) ⇒ Object

The #reorder method moves a Layout::Page to a different index within the Document‘s list of pages. This will move the Layout::Page such that its new index becomes new_index.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pages = doc.pages
pages.reorder(pages[1], 3)

Overloads:

  • #reorder(page, new_index) ⇒ Object

    Parameters:

    Raises:

    • (ArgumentError) —

      if the Layout::Page is not in the Document

    • (IndexError) —

      if new_index is out of range

  • #reorder(index, new_index) ⇒ Object

    Parameters:

    • index (Integer) —

      The index of the Layout::Page to be reordered

    • new_index (Integer) —

      The index to put the Layout::Page at

    Raises:

    • (IndexError) —

      if index or new_index is out of range

Version:

  • LayOut 2018



201
202
 
# File 'lib/sketchup-api-stubs/stubs/Layout/Pages.rb', line 201

def reorder(page, new_index)
end