Class: Layout::Document

Inherits:
Object
  • Object
show all

Overview

This is the interface to a LayOut document. A Document is the 2D drawing that the user is working with, and it serves as the “entry point” for most Ruby API interactions. The Document.open method gives you a handle to a Document, and from there you can use the document-level methods to start getting information and making changes.

Examples:

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

# Grab other handles to commonly used collections inside the model.
layers = doc.layers
pages = doc.pages
entities = doc.shared_entities

# Now that we have our handles, we can start pulling objects and making
# method calls that are useful.
first_entity = entities[0]

number_pages = pages.count

Version:

  • LayOut 2018

Constant Summary # collapse

Layout::Document::VERSION_1
Layout::Document::VERSION_2
Layout::Document::VERSION_3
Layout::Document::VERSION_2013
Layout::Document::VERSION_2014
Layout::Document::VERSION_2015
Layout::Document::VERSION_2016
Layout::Document::VERSION_2017
Layout::Document::VERSION_2018
Layout::Document::VERSION_2019
Layout::Document::VERSION_2020
Layout::Document::VERSION_2021
Layout::Document::VERSION_2022
Layout::Document::VERSION_2023
Layout::Document::VERSION_CURRENT
Layout::Document::FRACTIONAL_INCHES
Layout::Document::DECIMAL_INCHES
Layout::Document::DECIMAL_FEET
Layout::Document::DECIMAL_MILLIMETERS
Layout::Document::DECIMAL_CENTIMETERS
Layout::Document::DECIMAL_METERS
Layout::Document::DECIMAL_POINTS

Class Method Summary # collapse

Instance Method Summary # collapse

Constructor Details

↑ #initialize ⇒ Layout::Document #initialize(template_path) ⇒ Layout::Document

The #initialize method creates a new Layout::Document. Passing a path to an existing Layout::Document will use that file as a template. The new Layout::Document won't have a path until it is saved for the first time.

Examples:

doc = Layout::Document.new
doc2 = Layout::Document.new("/path/to/template.layout")

Overloads:

Raises:

  • (RuntimeError) —

    if there was an error reading the template file

  • (ArgumentError) —

    if the template file could not be found

Version:

  • LayOut 2018

Class Method Details

↑ .open(path) ⇒ Layout::Document

The open method creates a new Layout::Document by loading an existing .layout file.

Examples:

filename = File.join(ENV['Home'], 'Desktop', 'template.layout')
doc = Layout::Document.open(filename)

Parameters:

  • path (String) —

    The path to the .layout file on disk.

Returns:

Raises:

  • (ArgumentError) —

    if the file does not exist

Version:

  • LayOut 2018

Instance Method Details

↑ #==(other) ⇒ Boolean

The #== method checks to see if the two Layout::Documents are equal. This checks whether the Ruby Objects are pointing to the same internal object.

Examples:

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

Parameters:

Returns:

  • (Boolean)

Version:

  • LayOut 2018

↑ #add_entity(entity, layer, page) ⇒ Layout::Entity #add_entity(entity, layer) ⇒ Layout::Entity

The #add_entity method adds an Entity to the Layout::Document and places it on the given Layer and Page. If layer is a shared Layer then page may be ommitted. The Entity must not already belong to a Layout::Document. If the Entity is a Group, then the Group along with all of its children will be added to the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
rect = Layout::Rectangle.new([[1, 1], [2, 2]])
all_layers = doc.layers
all_pages = doc.pages
doc.add_entity(rect, all_layers.first, all_pages.first)

Overloads:

Returns:

Raises:

  • (ArgumentError) —

    if no Page is passed in and layer is non-shared

  • (ArgumentError) —

    if page does not belong to the Layout::Document

  • (ArgumentError) —

    if layer does not belong to the Layout::Document

  • (ArgumentError) —

    if entity already belongs to a Layout::Document

Version:

  • LayOut 2018

↑ #attribute_dictionary(name) ⇒ Layout::Dictionary?

The #attribute_dictionary method returns a copy of the document's attribute dictionary with the given name.

is no attribute dictionary

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
doc.set_attribute("jane_doe_doc_maker", "made_by_doc_maker", true)
attributes = doc.attribute_dictionary("jane_doe_doc_maker")
# Adding to this Layout::Dictionary does not apply to the document's attribute dictionary, use
#Layout::Document#set_attribute.
attributes.merge!(doc_id: 42)

Parameters:

Returns:

  • (Layout::Dictionary, nil) —

    A copy of the document's attribute dictionary, or nil if there

Version:

  • LayOut 2026.0

↑ #auto_text_definitions ⇒ Layout::AutoTextDefinitions

The #auto_text_definitions method returns an array of AutoTextDefinition's in the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
defs = doc.auto_text_definitions

Returns:

Version:

  • LayOut 2018

↑ #delete_attribute(dictionary_name) ⇒ Boolean #delete_attribute(dictionary_name, key) ⇒ Boolean

The #delete_attribute method is used to delete an attribute from a document.

Overloads:

  • #delete_attribute(dictionary_name) ⇒ Boolean

    Examples:

    doc = Layout::Document.open("C:/path/to/document.layout")
doc.set_attribute("jane_doe_doc_maker", "made_by_doc_maker", true)
doc.delete_attribute("jane_doe_doc_maker")

    Parameters:

    • dictionary_name (String) —

      The name of an attribute dictionary.

    Returns:

    • (Boolean)
  • #delete_attribute(dictionary_name, key) ⇒ Boolean

    Examples:

    doc = Layout::Document.open("C:/path/to/document.layout")
doc.set_attribute("jane_doe_doc_maker", "made_by_doc_maker", true)
doc.delete_attribute("jane_doe_doc_maker", "made_by_doc_maker")

    Parameters:

    • dictionary_name (String) —

      The name of an attribute dictionary.

    • key (String) —

      An attribute key.

    Returns:

    • (Boolean)

Version:

  • LayOut 2026.0

↑ #export(file_path, options = nil) ⇒ Object

The #export method exports the Layout::Document to a given file format. It knows which format to export based on the file extension you place on the file name. For example, a filename of “thing.pdf” will export a PDF file, whereas “thing.png” will export a set of PNG images.

For LayOut version 2020.1, valid extensions include .pdf, .jpg, and .png.

Examples:

PDF Export Examples

doc = Layout::Document.open("c:/path/to/document.layout")

# Export pdf file on a PC, with default settings.
doc.export("c:/my_export.pdf")

# Export pages one through three at high quality, compressing jpeg images
# at 0.75 compression quality (valid range is 0.0 - 1.0). Note that the
# first page of a {Layout::Document} is index 0.
options = { start_page: 1,
            end_page: 3,
            compress_images: true,
            compress_quality: 0.75 }

doc.export("c:/my_export.pdf", options)

# Export pages one and three through five. Note that page_range starts at
# index 1.
# `page_range` support added in LayOut 2024.0.
options = { page_range: "1,3-5",
            compress_images: true,
            compress_quality: 0.75 }

doc.export("c:/my_export.pdf", options)

Image Set Export Examples

doc = Layout::Document.open("c:/path/to/document.layout")

# Export png files on macOS, with default settings.
doc.export("/Users/<username>/Desktop/pngs/page.png")

# Export pages one through three at 300 dpi as JPGs.
options = { start_page: 1,
            end_page: 3,
            dpi: 300 }
doc.export('c:/page.jpg', options)

# Export pages one and three through five. Note that page_range starts at
# index 1.
# `page_range` support added in LayOut 2024.0.
options = { page_range: "1,3-5",
            compress_images: true,
            compress_quality: 0.75 }

doc.export("c:/my_export.png", options)

Parameters:

  • file_path (String) —

    The file or image set to create. The directory path must already exist. The path must include the file extension.

  • options (Hash, nil) (defaults to: nil) —

    An optional hash of settings for the export.

Options Hash (options):

  • :start_page (Integer) —

    The first page to export.

  • :end_page (Integer) —

    The last page to export.

  • :page_range (String) —

    A string specifying the range of pages to export. The format can include individual page numbers and ranges of pages, separated by commas (e.g., “1,3-5”). This was added in LayOut 2024.0

  • :compress_images (Boolean) —

    Whether to compress images in the document. This is valid only for image compression for PDF exports.

  • :compress_quality (Float) —

    The compression quality for JPEG images. This is valid only for the quality of the compression of images for PDF exports.

  • :dpi (Integer) —

    The resolution in dots per inch for the exported images. This option is only valid for image exports.

Raises:

  • (TypeError) —

    if an options value is the wrong type

  • (RangeError) —

    if an options value is out of range

  • (ArgumentError) —

    if the full file path does not exist

  • (ArgumentError) —

    if the specified file type is missing or not supported

Version:

  • LayOut 2020.1

↑ #get_attribute(name, key, default_value = nil) ⇒ String, ...

The #get_attribute method is used to retrieve the value of an attribute in the document's attribute dictionary.

If the third parameter, default_value, is not passed and there is no attribute that matches the given name, it returns nil.

If default_value is provided and there is no matching attribute it returns the given value. It does not create an attribute with that name though.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
# Read an attribute value from the document. In this case this will return the
# default value provided: 42.
doc.get_attribute("jane_doe_doc_maker", "doc_id", 42)

Parameters:

  • name (String) —

    The name of an attribute dictionary.

  • key (String) —

    An attribute key.

  • default_value (String, Boolean, Integer, Float, Hash, Layout::Dictionary, nil) (defaults to: nil) —

    A default value to return if no attribute is found.

Returns:

Version:

  • LayOut 2026.0

↑ #grid ⇒ Layout::Grid

The #grid method returns the Grid for a Layout::Document.

Examples:

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

Returns:

Version:

  • LayOut 2018

↑ #grid_snap_enabled=(enabled) ⇒ Object

The #grid_snap_enabled= method sets whether or not grid snap is enabled in the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
doc.grid_snap_enabled = true

Parameters:

  • enabled (Boolean) —

    true for enabled false for disabled

Version:

  • LayOut 2018

↑ #grid_snap_enabled? ⇒ Boolean

The #grid_snap_enabled? method returns whether or not grid snap is enabled in the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
enabled = doc.grid_snap_enabled?

Returns:

  • (Boolean)

Version:

  • LayOut 2018

↑ #layers ⇒ Layout::Layers

The #layers method returns the Layers of the Layout::Document.

Examples:

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

Returns:

Version:

  • LayOut 2018

↑ #object_snap_enabled=(enabled) ⇒ Object

The #object_snap_enabled= method enables or disables inference in the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
doc.object_snap_enabled = false

Parameters:

  • enabled (Boolean) —

    true for enabled false for disabled

Version:

  • LayOut 2018

↑ #object_snap_enabled? ⇒ Boolean

The #object_snap_enabled? method returns whether or not inference is enabled in the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
enabled = doc.object_snap_enabled?

Returns:

  • (Boolean)

Version:

  • LayOut 2018

↑ #page_info ⇒ Layout::PageInfo

The #page_info method returns a reference to the PageInfo settings of the Layout::Document.

Examples:

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

Returns:

Version:

  • LayOut 2018

↑ #pages ⇒ Layout::Pages

The #pages method returns the Pages of the Layout::Document.

@example:

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

Returns:

Version:

  • LayOut 2018

↑ #path ⇒ String

The #path method returns the full path of the Layout::Document file. An empty string is returned for a new Layout::Document (one which has not been saved and opened).

Examples:

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

Returns:

Version:

  • LayOut 2018

↑ #precision ⇒ Float

The #precision method returns the precision for the Layout::Document.

Examples:

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

Returns:

Version:

  • LayOut 2018

↑ #precision=(precision) ⇒ Object

Note:

LayOut only allows for a finite set of precision values for each units setting, so it will set the precision to the closest valid setting for the specified units. See the “Units” section of LayOut's “Document Setup” dialog for a reference of the available precisions for each units setting.

The #precision= method sets the precision for the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
doc.precision = 0.0001

Parameters:

  • precision (Float) —

    The double specifying the precision for the Layout::Document

Version:

  • LayOut 2018

↑ #remove_entity(entity) ⇒ Object

The #remove_entity method removes an Entity from the Layout::Document. If entity is a Group, then the Group and all of its children will be removed from the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
shared_entities = doc.shared_entities
# Remove the first entity in the document
doc.remove_entity(shared_entities.first)

Parameters:

Raises:

Version:

  • LayOut 2018

↑ #render_mode_override ⇒ Integer

The #render_mode_override method returns the override setting for output render modes of SketchUpModels in the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
render_mode = doc.render_mode_override

Returns:

  • (Integer)

Version:

  • LayOut 2023.1

↑ #render_mode_override=(render_mode) ⇒ Object

The #render_mode_override= method sets the override setting for output render modes of SketchUpModels in the Layout::Document. Setting this to NO_OVERRIDE will prevent overriding the individual SketchUpModel render mode setting during export. This override will only affect raster rendered SketchUpModels, if a viewport is set to vector or hybrid, it will retain that render mode as its output render mode.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
doc.render_mode_override = Layout::SketchUpModel::VECTOR_RENDER

Parameters:

  • render_mode (Integer) —

    NO_OVERRIDE, VECTOR_RENDER, or HYBRID_RENDER

Raises:

  • (ArgumentError) —

    if render_mode is not a valid render mode

  • (ArgumentError) —

    if render_mode is RASTER_RENDER

Version:

  • LayOut 2023.1

↑ #save ⇒ Object #save(path, version = Layout::Document::VERSION_CURRENT) ⇒ Object

The #save method saves the Layout::Document to a file at the given path. Passing an empty path string will save the Layout::Document at its current path.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
# Save the model using the current Layout format
path = File.join(ENV['Home'], 'Desktop', 'mydoc.layout')
status = doc.save(path)
# Save the document to the current file using the current LayOut format
status = doc.save
# Save the document to the current file in LayOut 3 format
status = doc.save(Layout::Document::VERSION_3)
# Save the document in LayOut 2013 format
path = File.join(ENV['Home'], 'Desktop', 'mydoc_v2013.layout')
status = doc.save(path, Layout::Document::VERSION_2013)

Overloads:

  • #save ⇒ Object

    Raises:

  • #save(path, version = Layout::Document::VERSION_CURRENT) ⇒ Object

    Parameters:

    • path (String) —

      The path to the .layout file on disk.

    • version (Integer) (defaults to: Layout::Document::VERSION_CURRENT) —

      LayOut file format to save.

Raises:

  • (ArgumentError) —

    if version is not a valid version

  • (ArgumentError) —

    if saving failed. This may be due to the LayOut file being open in the LayOut application

Version:

  • LayOut 2018

↑ #set_attribute(name, key, value) ⇒ Object

The #set_attribute method adds an attribute to the document's attribute dictionary.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
doc.set_attribute "jane_doe_doc_maker", "doc_id", 42

Parameters:

  • name (String) —

    The name of an attribute dictionary. @param [String] key An attribute key. @param [String, Boolean, Integer, Float, Hash, Layout::Dictionary, nil] value The value for the

    attribute.

Version:

  • LayOut 2026.0

↑ #shared_entities ⇒ Layout::Entities

The #shared_entities method returns the Entities that exist on shared Layers in the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
entities = doc.shared_entities

Returns:

Version:

  • LayOut 2018

↑ #time_created ⇒ Time

The #time_created method returns the time when the Layout::Document was created.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
created_time = doc.time_created

Returns:

Version:

  • LayOut 2018

↑ #time_modified ⇒ Time

The #time_modified method returns the last time the Layout::Document was modified.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
mod_time = doc.time_modified

Returns:

Version:

  • LayOut 2018

↑ #time_published ⇒ Time

The #time_published method returns the time when the Layout::Document was published.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
pub_time = doc.time_published

Returns:

Version:

  • LayOut 2018

↑ #units ⇒ Integer

The #units method returns the units for the Layout::Document.

Examples:

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

Returns:

Version:

  • LayOut 2018

↑ #units=(units_format) ⇒ Object

The #units= method sets the units for the Layout::Document.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
units_format = LAYOUT::DOCUMENT::DECIMAL_MILLIMETERS
doc.units = units_format

Parameters:

Raises:

  • (ArgumentError) —

    if units format is not a valid format

Version:

  • LayOut 2018