Class: Layout::Grid

Inherits:

Object

• Object
• Layout::Grid

Overview

Class that references a Document's grid settings.

Version:

• LayOut 2018

Instance Method Summary

• #major_color ⇒ Sketchup::Color

  The #major_color method returns the Sketchup::Color for the major grid lines.

• #major_spacing ⇒ Numeric

  The #major_spacing method returns the major space size of the Grid.

• #minor_color ⇒ Sketchup::Color

  The #minor_color method returns the Sketchup::Color for the minor grid lines.

• #minor_divisions ⇒ Integer

  The #minor_divisions method returns the number of minor divisions of the Grid.

• #print? ⇒ Boolean

  The #print? method returns whether or not the Grid is printed.

• #show? ⇒ Boolean

  The #show? method returns whether or not the Grid is visible.

• #show_major? ⇒ Boolean

  The #show_major? method returns whether or not the major grid lines are visible.

• #show_minor? ⇒ Boolean

  The #show_minor? method returns whether or not the minor grid lines are visible.

Instance Method Details

#major_color ⇒ Sketchup::Color

The #major_color method returns the Sketchup::Color for the major grid lines.

Examples:

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

Returns:

• (Sketchup::Color)

Version:

• LayOut 2018

#major_spacing ⇒ Numeric

The #major_spacing method returns the major space size of the Layout::Grid.

Examples:

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

Returns:

• (Numeric)

Version:

• LayOut 2018

#minor_color ⇒ Sketchup::Color

The #minor_color method returns the Sketchup::Color for the minor grid lines.

Examples:

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

Returns:

• (Sketchup::Color)

Version:

• LayOut 2018

#minor_divisions ⇒ Integer

The #minor_divisions method returns the number of minor divisions of the Layout::Grid.

Examples:

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

Returns:

• (Integer)

Version:

• LayOut 2018

#print? ⇒ Boolean

The #print? method returns whether or not the Layout::Grid is printed.

Examples:

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

Returns:

• (Boolean)

Version:

• LayOut 2018

#show? ⇒ Boolean

The #show? method returns whether or not the Layout::Grid is visible.

Examples:

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

Returns:

• (Boolean)

Version:

• LayOut 2018

#show_major? ⇒ Boolean

The #show_major? method returns whether or not the major grid lines are visible.

Examples:

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

Returns:

• (Boolean)

Version:

• LayOut 2018

#show_minor? ⇒ Boolean

The #show_minor? method returns whether or not the minor grid lines are visible.

Examples:

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

Returns:

• (Boolean)

Version:

• LayOut 2018