Class: Layout::Style

Inherits:
Object
  • Object
show all
Defined in:
SketchUp/Layout/Style.rb

Overview

References a collection of style attributes that determine the visual appearance of Entitys. Style attributes are those attributes which the user can manipulate in LayOut’s inspector windows. For example, shape style attributes that define stroke and fill, or text style attributes that define the font for FormattedText. The Document maintains a default style for various types of Entitys, and it is possible to apply the style of one entity to another. Style objects are transient and do not belong to a Document.

Version:

  • LayOut 2018

Constant Summary collapse

ALIGN_CENTER =

Constants

nil
ALIGN_LEFT =

Stub value.

nil
ALIGN_RIGHT =

Stub value.

nil
ARCHITECTURAL_INCHES =

Stub value.

nil
ANCHOR_BOTTOM =

Stub value.

nil
ANCHOR_CENTER =

Stub value.

nil
ANCHOR_TOP =

Stub value.

nil
ARROW_FILLED_CIRCLE =

Stub value.

nil
ARROW_FILLED_DIAMOND =

Stub value.

nil
ARROW_FILLED_SKINNY_TRIANGLE =

Stub value.

nil
ARROW_FILLED_SQUARE =

Stub value.

nil
ARROW_FILLED_TRIANGLE =

Stub value.

nil
ARROW_NONE =

Stub value.

nil
ARROW_OPEN_ARROW_120 =

Stub value.

nil
ARROW_OPEN_ARROW_90 =

Stub value.

nil
ARROW_OPEN_CIRCLE =

Stub value.

nil
ARROW_OPEN_DIAMOND =

Stub value.

nil
ARROW_OPEN_SKINNY_TRIANGLE =

Stub value.

nil
ARROW_OPEN_SQUARE =

Stub value.

nil
ARROW_OPEN_TRIANGLE =

Stub value.

nil
ARROW_OVERRUN =

Stub value.

nil
ARROW_SLASH_LEFT =

Stub value.

nil
ARROW_SLASH_RIGHT =

Stub value.

nil
ARROW_STAR =

Stub value.

nil
ARROW_T =

Stub value.

nil
ARROW_UNDERRUN =

Stub value.

nil
CAP_STYLE_FLAT =

Stub value.

nil
CAP_STYLE_ROUND =

Stub value.

nil
CAP_STYLE_SQUARE =

Stub value.

nil
DECIMAL_CENTIMETERS =

Stub value.

nil
DECIMAL_FEET =

Stub value.

nil
DECIMAL_INCHES =

Stub value.

nil
DECIMAL_METERS =

Stub value.

nil
DECIMAL_MILLIMETERS =

Stub value.

nil
DECIMAL_POINTS =

Stub value.

nil
DEGREES =

Stub value.

nil
DIMENSION_END_EXTENSION_LINE =

Stub value.

nil
DIMENSION_LEADER_LINE =

Stub value.

nil
DIMENSION_LINE =

Stub value.

nil
DIMENSION_START_EXTENSION_LINE =

Stub value.

nil
DIMENSION_TEXT =

Stub value.

nil
DIMENSION_TEXT_ABOVE =

Stub value.

nil
DIMENSION_TEXT_BELOW =

Stub value.

nil
DIMENSION_TEXT_CENTER =

Stub value.

nil
DIMENSION_TEXT_HORIZONTAL =

Stub value.

nil
DIMENSION_TEXT_OFFSET =

Stub value.

nil
DIMENSION_TEXT_PARALLEL =

Stub value.

nil
DIMENSION_TEXT_PERPENDICULAR =

Stub value.

nil
DIMENSION_TEXT_VERTICAL =

Stub value.

nil
ENGINEERING_FEET =

Stub value.

nil
FRACTIONAL_INCHES =

Stub value.

nil
JOIN_STYLE_BEVEL =

Stub value.

nil
JOIN_STYLE_MITER =

Stub value.

nil
JOIN_STYLE_ROUND =

Stub value.

nil
LABEL_LEADER_LINE =

Stub value.

nil
LABEL_TEXT =

Stub value.

nil
NORMAL_SCRIPT =

Stub value.

nil
RADIANS =

Stub value.

nil
SUPER_SCRIPT =

Stub value.

nil
STROKE_PATTERN_CENTER =

Stub value.

nil
STROKE_PATTERN_DASH =

Stub value.

nil
STROKE_PATTERN_DASH_DASH_DOT =

Stub value.

nil
STROKE_PATTERN_DASH_DASH_DOT_DOT =

Stub value.

nil
STROKE_PATTERN_DASH_DASH_DOT_DOT_DOT =

Stub value.

nil
STROKE_PATTERN_DASH_DOT =

Stub value.

nil
STROKE_PATTERN_DASH_DOT_DOT =

Stub value.

nil
STROKE_PATTERN_DASH_DOT_DOT_DOT =

Stub value.

nil
STROKE_PATTERN_DASH_SPACE =

Stub value.

nil
STROKE_PATTERN_DOT =

Stub value.

nil
STROKE_PATTERN_PHANTOM =

Stub value.

nil
STROKE_PATTERN_SOLID =

Stub value.

nil
SUB_SCRIPT =

Stub value.

nil
UNDERLINE_DOUBLE =

Stub value.

nil
UNDERLINE_NONE =

Stub value.

nil
UNDERLINE_SINGLE =

Stub value.

nil

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Layout::Style

The #initialize method creates a new Layout::Style.

Examples:

style = Layout::Style.new

Version:

  • LayOut 2018



525
526
 
# File 'SketchUp/Layout/Style.rb', line 525

def initialize
end

Class Method Details

.arrow_type_filled?(arrow_type) ⇒ Boolean

The arrow_type_filled? method returns whether the specified arrow type is filled or not.

The arrow type can be one of the following values:

Layout::Style::ARROW_NONE
Layout::Style::ARROW_FILLED_TRIANGLE
Layout::Style::ARROW_OPEN_TRIANGLE
Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_ARROW_90
Layout::Style::ARROW_OPEN_ARROW_120
Layout::Style::ARROW_FILLED_CIRCLE
Layout::Style::ARROW_OPEN_CIRCLE
Layout::Style::ARROW_FILLED_SQUARE
Layout::Style::ARROW_OPEN_SQUARE
Layout::Style::ARROW_FILLED_DIAMOND
Layout::Style::ARROW_OPEN_DIAMOND
Layout::Style::ARROW_STAR
Layout::Style::ARROW_T
Layout::Style::ARROW_SLASH_RIGHT
Layout::Style::ARROW_SLASH_LEFT
Layout::Style::ARROW_UNDERRUN
Layout::Style::ARROW_OVERRUN

Examples:

# Returns false
filled = Layout::Style.arrow_type_filled?(Layout::Style::ARROW_T)
# Returns true
filled = Layout::Style.arrow_type_filled?(Layout::Style::ARROW_FILLED_SQUARE)

Returns:

  • (Boolean)
  • (Boolean)

Version:

  • LayOut 2018



149
150
 
# File 'SketchUp/Layout/Style.rb', line 149

def self.arrow_type_filled?(arrow_type)
end

Instance Method Details

#dimension_rotation_alignment ⇒ Integer?

The #dimension_rotation_alignment method returns the rotational text alignment for LinearDimension text, or nil if the Layout::Style does not have a value for that setting.

The rotational alignment type can be one of the following values:

Layout::Style::DIMENSION_TEXT_HORIZONTAL
Layout::Style::DIMENSION_TEXT_VERTICAL
Layout::Style::DIMENSION_TEXT_PARALLEL
Layout::Style::DIMENSION_TEXT_PERPENDICULAR

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
dimension_alignment = style.dimension_rotation_alignment

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



174
175
 
# File 'SketchUp/Layout/Style.rb', line 174

def dimension_rotation_alignment
end

#dimension_rotation_alignment=(alignment_type) ⇒ Object

The #dimension_rotation_alignment= method sets the rotational text alignment.

The rotational alignment type can be one of the following values:

Layout::Style::DIMENSION_TEXT_HORIZONTAL
Layout::Style::DIMENSION_TEXT_VERTICAL
Layout::Style::DIMENSION_TEXT_PARALLEL
Layout::Style::DIMENSION_TEXT_PERPENDICULAR

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.dimension_rotation_alignment = Layout::Style::DIMENSION_TEXT_HORIZONTAL
# Set the style to apply changes
entity.style = style

Parameters:

  • alignment_type (Integer)

Raises:

  • (ArgumentError) —

    if alignment_type is not a valid alignment type

Version:

  • LayOut 2018



200
201
 
# File 'SketchUp/Layout/Style.rb', line 200

def dimension_rotation_alignment=(alignment_type)
end

#dimension_units ⇒ Array(Integer, Float)?

The #dimension_units method returns the unit format and precision for dimensions, or nil if the Layout::Style does not have a value for that setting. Units may be for either LinearDimensions or AngularDimensions, but not both.

The units can be one of the following values:

Layout::Style::FRACTIONAL_INCHES
Layout::Style::ARCHITECTURAL_INCHES
Layout::Style::ENGINEERING_FEET
Layout::Style::DECIMAL_INCHES
Layout::Style::DECIMAL_FEET
Layout::Style::DECIMAL_MILLIMETERS
Layout::Style::DECIMAL_CENTIMETERS
Layout::Style::DECIMAL_METERS
Layout::Style::DECIMAL_POINTS
Layout::Style::DEGREES
Layout::Style::RADIANS

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
units, precision = style.dimension_units

Returns:

  • (Array(Integer, Float), nil)

Version:

  • LayOut 2018



231
232
 
# File 'SketchUp/Layout/Style.rb', line 231

def dimension_units
end

#dimension_vertical_alignment ⇒ Integer?

The #dimension_vertical_alignment method returns the vertical text alignment for LinearDimension text, or nil if the Layout::Style does not have a value for that setting.

The vertical alignment type can be one of the following values:

Layout::Style::DIMENSION_TEXT_ABOVE
Layout::Style::DIMENSION_TEXT_CENTER
Layout::Style::DIMENSION_TEXT_BELOW
Layout::Style::DIMENSION_TEXT_OFFSET

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
dimension_alignment = style.dimension_vertical_alignment

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



254
255
 
# File 'SketchUp/Layout/Style.rb', line 254

def dimension_vertical_alignment
end

#dimension_vertical_alignment=(alignment_type) ⇒ Object

The #dimension_vertical_alignment= method sets the vertical text alignment for LinearDimension text.

The vertical alignment type can be one of the following values:

Layout::Style::DIMENSION_TEXT_ABOVE
Layout::Style::DIMENSION_TEXT_CENTER
Layout::Style::DIMENSION_TEXT_BELOW
Layout::Style::DIMENSION_TEXT_OFFSET

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.dimension_vertical_alignment = Layout::Style::DIMENSION_TEXT_ABOVE
# Set the style to apply changes
entity.style = style

Parameters:

  • alignment_type (Integer)

Raises:

  • (ArgumentError) —

    if alignment_type is not a valid alignment type

Version:

  • LayOut 2018



280
281
 
# File 'SketchUp/Layout/Style.rb', line 280

def dimension_vertical_alignment=(alignment_type)
end

#end_arrow_size ⇒ Float?

The #end_arrow_size method returns the size of the end arrow, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
arrow_size = style.start_arrow_size

Returns:

  • (Float, nil)

Version:

  • LayOut 2018



296
297
 
# File 'SketchUp/Layout/Style.rb', line 296

def end_arrow_size
end

#end_arrow_size=(arrow_size) ⇒ Object

The #end_arrow_size= method sets the size of the end arrow. The minimum size is 0.25.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.end_arrow_size = 2.0
# Set the style to apply changes
entity.style = style

Parameters:

  • arrow_size (Float)

Raises:

  • (ArgumentError) —

    if arrow_size is less than 0.25

Version:

  • LayOut 2018



316
317
 
# File 'SketchUp/Layout/Style.rb', line 316

def end_arrow_size=(arrow_size)
end

#end_arrow_type ⇒ Integer?

The #end_arrow_type method returns the type of end arrow, or nil if the Layout::Style does not have a value for that setting.

The arrow type can be one of the following values:

Layout::Style::ARROW_NONE
Layout::Style::ARROW_FILLED_TRIANGLE
Layout::Style::ARROW_OPEN_TRIANGLE
Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_ARROW_90
Layout::Style::ARROW_OPEN_ARROW_120
Layout::Style::ARROW_FILLED_CIRCLE
Layout::Style::ARROW_OPEN_CIRCLE
Layout::Style::ARROW_FILLED_SQUARE
Layout::Style::ARROW_OPEN_SQUARE
Layout::Style::ARROW_FILLED_DIAMOND
Layout::Style::ARROW_OPEN_DIAMOND
Layout::Style::ARROW_STAR
Layout::Style::ARROW_T
Layout::Style::ARROW_SLASH_RIGHT
Layout::Style::ARROW_SLASH_LEFT
Layout::Style::ARROW_UNDERRUN
Layout::Style::ARROW_OVERRUN

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
arrow_type = style.end_arrow_type

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



353
354
 
# File 'SketchUp/Layout/Style.rb', line 353

def end_arrow_type
end

#end_arrow_type=(arrow_type) ⇒ Object

The #end_arrow_type= method sets the type of end arrow.

The arrow type can be one of the following values:

Layout::Style::ARROW_NONE
Layout::Style::ARROW_FILLED_TRIANGLE
Layout::Style::ARROW_OPEN_TRIANGLE
Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_ARROW_90
Layout::Style::ARROW_OPEN_ARROW_120
Layout::Style::ARROW_FILLED_CIRCLE
Layout::Style::ARROW_OPEN_CIRCLE
Layout::Style::ARROW_FILLED_SQUARE
Layout::Style::ARROW_OPEN_SQUARE
Layout::Style::ARROW_FILLED_DIAMOND
Layout::Style::ARROW_OPEN_DIAMOND
Layout::Style::ARROW_STAR
Layout::Style::ARROW_T
Layout::Style::ARROW_SLASH_RIGHT
Layout::Style::ARROW_SLASH_LEFT
Layout::Style::ARROW_UNDERRUN
Layout::Style::ARROW_OVERRUN

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.end_arrow_type = Layout::Style::ARROW_SLASH_LEFT
# Set the style to apply changes
entity.style = style

Parameters:

  • arrow_type (Integer)

Raises:

  • (ArgumentError) —

    if arrow_type is not a valid arrow type

Version:

  • LayOut 2018



393
394
 
# File 'SketchUp/Layout/Style.rb', line 393

def end_arrow_type=(arrow_type)
end

#fill_color ⇒ Sketchup::Color?

The #fill_color method returns the solid file color, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
color = style.fill_color

Returns:

Version:

  • LayOut 2018



409
410
 
# File 'SketchUp/Layout/Style.rb', line 409

def fill_color
end

#fill_color=(fill_color) ⇒ Object

The #fill_color= method sets the solid fill color.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.solid_filled = true
style.fill_color = Sketchup::Color.new(0, 255, 0, 255)
# Set the style to apply changes
entity.style = style

Parameters:

Version:

  • LayOut 2018



427
428
 
# File 'SketchUp/Layout/Style.rb', line 427

def fill_color=(fill_color)
end

#font_family ⇒ String?

The #font_family method returns the text font name, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
font_name = style.font_family

Returns:

Version:

  • LayOut 2018



443
444
 
# File 'SketchUp/Layout/Style.rb', line 443

def font_family
end

#font_family=(font_family) ⇒ Object

The #font_family= method sets the text font name.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.font_family = "Verdana"
# Set the style to apply changes
entity.style = style

Parameters:

Version:

  • LayOut 2018



460
461
 
# File 'SketchUp/Layout/Style.rb', line 460

def font_family=(font_family)
end

#font_size ⇒ Float?

The #font_size method returns the font size, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
font_size = style.font_size

Returns:

  • (Float, nil)

Version:

  • LayOut 2018



476
477
 
# File 'SketchUp/Layout/Style.rb', line 476

def font_size
end

#font_size=(font_size) ⇒ Object

The #font_size= method sets the font size.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.font_size = 12.0
# Set the style to apply changes
entity.style = style

Parameters:

  • font_size (Float)

Version:

  • LayOut 2018



493
494
 
# File 'SketchUp/Layout/Style.rb', line 493

def font_size=(font_size)
end

#get_sub_style(type) ⇒ Layout::Style

The #get_sub_style method returns the Layout::Style for a sub-entity from the Layout::Style. This would be used to get the current style of a LinearDimension‘s text, for example.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
sub_style = style.get_sub_style(Layout::Style::DIMENSION_TEXT)

Parameters:

  • type (Integer)

Returns:

Raises:

  • (ArgumentError) —

    if type is not a valid sub-entity type.

Version:

  • LayOut 2018



514
515
 
# File 'SketchUp/Layout/Style.rb', line 514

def get_sub_style(type)
end

#pattern_fill_origin ⇒ Geom::Point2d?

The #pattern_fill_origin method returns the starting piont for the pattern fill, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
origin = style.pattern_fill_origin

Returns:

Version:

  • LayOut 2018



541
542
 
# File 'SketchUp/Layout/Style.rb', line 541

def pattern_fill_origin
end

#pattern_fill_origin=(origin) ⇒ Object

The #pattern_fill_origin= method sets the starting point for the pattern fill.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.pattern_filled = true
style.pattern_fill_path = "C:/path/to/pattern.png"
style.pattern_fill_origin = [2, 1]
# Set the style to apply changes
entity.style = style

Parameters:

Version:

  • LayOut 2018



561
562
 
# File 'SketchUp/Layout/Style.rb', line 561

def pattern_fill_origin=(origin)
end

#pattern_fill_path ⇒ String?

The #pattern_fill_path method returns the file path to the pattern fill image, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
path = style.pattern_fill_path

Returns:

Version:

  • LayOut 2018



577
578
 
# File 'SketchUp/Layout/Style.rb', line 577

def pattern_fill_path
end

#pattern_fill_path=(path) ⇒ Object

The #pattern_fill_path= method sets the path to the image to use for the pattern fill.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.pattern_filled = true
style.pattern_fill_path = "C:/path/to/pattern.png"
# Set the style to apply changes
entity.style = style

Parameters:

Raises:

  • (ArgumentError) —

    if the image specified by path could not be loaded

Version:

  • LayOut 2018



598
599
 
# File 'SketchUp/Layout/Style.rb', line 598

def pattern_fill_path=(path)
end

#pattern_fill_rotation ⇒ Float?

The #pattern_fill_rotation method returns the rotation of the pattern fill image in degrees, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
rotation = style.pattern_fill_rotation

Returns:

  • (Float, nil)

Version:

  • LayOut 2018



615
616
 
# File 'SketchUp/Layout/Style.rb', line 615

def pattern_fill_rotation
end

#pattern_fill_rotation=(rotation) ⇒ Object

The #pattern_fill_rotation= method sets the rotation in degrees of the pattern fill image.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.pattern_filled = true
style.pattern_fill_path = "C:/path/to/pattern.png"
style.pattern_fill_rotation = -90.0
# Set the style to apply changes
entity.style = style

Parameters:

  • rotation (Float)

Version:

  • LayOut 2018



635
636
 
# File 'SketchUp/Layout/Style.rb', line 635

def pattern_fill_rotation=(rotation)
end

#pattern_fill_scale ⇒ Float?

The #pattern_fill_scale method returns the pattern fill scale, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
scale = style.pattern_fill_scale

Returns:

  • (Float, nil)

Version:

  • LayOut 2018



651
652
 
# File 'SketchUp/Layout/Style.rb', line 651

def pattern_fill_scale
end

#pattern_fill_scale=(scale) ⇒ Object

The #pattern_fill_scale= method sets the pattern fill scale.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.pattern_filled = true
style.pattern_fill_path = "C:/path/to/pattern.png"
style.pattern_fill_scale = 2.0
# Set the style to apply changes
entity.style = style

Parameters:

  • scale (Float)

Raises:

  • (ArgumentError) —

    if scale is less than 0.1 or greater than 9999.0

Version:

  • LayOut 2018



672
673
 
# File 'SketchUp/Layout/Style.rb', line 672

def pattern_fill_scale=(scale)
end

#pattern_filled ⇒ Boolean?

The #pattern_filled method returns whether the Layout::Style has a pattern fill, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
is_filled = style.pattern_filled

Returns:

  • (Boolean, nil)

Version:

  • LayOut 2018



689
690
 
# File 'SketchUp/Layout/Style.rb', line 689

def pattern_filled
end

#pattern_filled=(filled) ⇒ Object

The #pattern_filled= method sets whether the Layout::Style has a pattern fill.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.pattern_filled = true
style.pattern_fill_path = "C:/path/to/pattern.png"
# Set the style to apply changes
entity.style = style

Parameters:

  • filled (Boolean)

Version:

  • LayOut 2018



708
709
 
# File 'SketchUp/Layout/Style.rb', line 708

def pattern_filled=(filled)
end

#set_dimension_units(units, precision) ⇒ Object

The #set_dimension_units method sets the unit format and precision for dimensions. Units may be for either LinearDimensions or AngularDimensions, but not both.

The units can be one of the following values:

Layout::Style::FRACTIONAL_INCHES
Layout::Style::ARCHITECTURAL_INCHES
Layout::Style::ENGINEERING_FEET
Layout::Style::DECIMAL_INCHES
Layout::Style::DECIMAL_FEET
Layout::Style::DECIMAL_MILLIMETERS
Layout::Style::DECIMAL_CENTIMETERS
Layout::Style::DECIMAL_METERS
Layout::Style::DECIMAL_POINTS
Layout::Style::DEGREES
Layout::Style::RADIANS

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
precision = 0.0001
units = Layout::Style::DECIMAL_MILLIMETERS
style.set_dimension_units(units, precision)

Parameters:

  • units (Integer)
  • precision (Float)

Raises:

  • (ArgumentError) —

    if units is not a valid unit format

Version:

  • LayOut 2018



744
745
 
# File 'SketchUp/Layout/Style.rb', line 744

def set_dimension_units(units, precision)
end

#set_sub_style(type, sub_style) ⇒ Object

The #set_sub_style method adds a Layout::Style to apply to a Entity‘s sub-entity. This would be used to set the arrow type for extension lines of a LinearDimension, for example.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
sub_style = style.get_sub_style(Layout::Style::DIMENSION_TEXT)
sub_style.dimension_vertical_alignment = Layout::Style::DIMENSION_TEXT_BELOW
style.set_sub_style(Layout::Style::DIMENSION_TEXT, sub_style)
# Set the style to apply changes
entity.style = style

Parameters:

Raises:

  • (ArgumentError) —

    if type is not a valid sub-entity type.

Version:

  • LayOut 2018



769
770
 
# File 'SketchUp/Layout/Style.rb', line 769

def set_sub_style(type, sub_style)
end

#solid_filled ⇒ Boolean?

The #solid_filled method returns whether the Layout::Style has a solid fill, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
is_filled = style.solid_filled

Returns:

  • (Boolean, nil)

Version:

  • LayOut 2018



785
786
 
# File 'SketchUp/Layout/Style.rb', line 785

def solid_filled
end

#solid_filled=(filled) ⇒ Object

The #solid_filled= method sets whether the Layout::Style has a solid fill.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.solid_filled = true
style.fill_color = Sketchup::Color.new(0, 255, 0, 255)
# Set the style to apply changes
entity.style = style

Parameters:

  • filled (Boolean)

Version:

  • LayOut 2018



803
804
 
# File 'SketchUp/Layout/Style.rb', line 803

def solid_filled=(filled)
end

#start_arrow_size ⇒ Float?

The #start_arrow_size method returns the size of the start arrow, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
arrow_size = style.start_arrow_size

Returns:

  • (Float, nil)

Version:

  • LayOut 2018



819
820
 
# File 'SketchUp/Layout/Style.rb', line 819

def start_arrow_size
end

#start_arrow_size=(arrow_size) ⇒ Object

The #start_arrow_size= method sets the size of the start arrow. The minimum size is 0.25.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.start_arrow_size = 2.0
# Set the style to apply changes
entity.style = style

Parameters:

  • arrow_size (Float)

Raises:

  • (ArgumentError) —

    if arrow_size is less than 0.25

Version:

  • LayOut 2018



839
840
 
# File 'SketchUp/Layout/Style.rb', line 839

def start_arrow_size=(arrow_size)
end

#start_arrow_type ⇒ Integer?

The #start_arrow_type method returns the type of start arrow, or nil if the Layout::Style does not have a value for that setting.

The arrow type can be one of the following values:

Layout::Style::ARROW_NONE
Layout::Style::ARROW_FILLED_TRIANGLE
Layout::Style::ARROW_OPEN_TRIANGLE
Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_ARROW_90
Layout::Style::ARROW_OPEN_ARROW_120
Layout::Style::ARROW_FILLED_CIRCLE
Layout::Style::ARROW_OPEN_CIRCLE
Layout::Style::ARROW_FILLED_SQUARE
Layout::Style::ARROW_OPEN_SQUARE
Layout::Style::ARROW_FILLED_DIAMOND
Layout::Style::ARROW_OPEN_DIAMOND
Layout::Style::ARROW_STAR
Layout::Style::ARROW_T
Layout::Style::ARROW_SLASH_RIGHT
Layout::Style::ARROW_SLASH_LEFT
Layout::Style::ARROW_UNDERRUN
Layout::Style::ARROW_OVERRUN

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
arrow_type = style.start_arrow_type

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



876
877
 
# File 'SketchUp/Layout/Style.rb', line 876

def start_arrow_type
end

#start_arrow_type=(arrow_type) ⇒ Object

The #start_arrow_type= method sets the type of start arrow.

The arrow type can be one of the following values:

Layout::Style::ARROW_NONE
Layout::Style::ARROW_FILLED_TRIANGLE
Layout::Style::ARROW_OPEN_TRIANGLE
Layout::Style::ARROW_FILLED_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_SKINNY_TRIANGLE
Layout::Style::ARROW_OPEN_ARROW_90
Layout::Style::ARROW_OPEN_ARROW_120
Layout::Style::ARROW_FILLED_CIRCLE
Layout::Style::ARROW_OPEN_CIRCLE
Layout::Style::ARROW_FILLED_SQUARE
Layout::Style::ARROW_OPEN_SQUARE
Layout::Style::ARROW_FILLED_DIAMOND
Layout::Style::ARROW_OPEN_DIAMOND
Layout::Style::ARROW_STAR
Layout::Style::ARROW_T
Layout::Style::ARROW_SLASH_RIGHT
Layout::Style::ARROW_SLASH_LEFT
Layout::Style::ARROW_UNDERRUN
Layout::Style::ARROW_OVERRUN

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.start_arrow_type = Layout::Style::ARROW_SLASH_RIGHT
# Set the style to apply changes
entity.style = style

Parameters:

  • arrow_type (Integer)

Raises:

  • (ArgumentError) —

    if arrow_type is not a valid arrow type

Version:

  • LayOut 2018



916
917
 
# File 'SketchUp/Layout/Style.rb', line 916

def start_arrow_type=(arrow_type)
end

#stroke_cap_style ⇒ Integer?

The #stroke_cap_style method returns the stroke cap style, or nil if the Layout::Style does not have a value for that setting.

The cap style can be one of the following:

Layout::Style::CAP_STYLE_FLAT
Layout::Style::CAP_STYLE_ROUND
Layout::Style::CAP_STYLE_SQUARE

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
cap_style = style.stroke_cap_style

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



937
938
 
# File 'SketchUp/Layout/Style.rb', line 937

def stroke_cap_style
end

#stroke_cap_style=(cap_style) ⇒ Object

The #stroke_cap_style= method sets the stroke cap style.

The cap style can be one of the following:

Layout::Style::CAP_STYLE_FLAT
Layout::Style::CAP_STYLE_ROUND
Layout::Style::CAP_STYLE_SQUARE

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.stroke_cap_style = Layout::Style::CAP_STYLE_SQUARE
# Set the style to apply changes
entity.style = style

Parameters:

  • cap_style (Integer)

Raises:

  • (ArgumentError) —

    if cap_style is not a valid cap style

Version:

  • LayOut 2018



961
962
 
# File 'SketchUp/Layout/Style.rb', line 961

def stroke_cap_style=(cap_style)
end

#stroke_color ⇒ Sketchup::Color?

The #stroke_color method returns the stroke color, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
color = style.stroke_color

Returns:

Version:

  • LayOut 2018



977
978
 
# File 'SketchUp/Layout/Style.rb', line 977

def stroke_color
end

#stroke_color=(stroke_color) ⇒ Object

The #stroke_color= method sets the stroke color.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.stroke_color = Sketchup::Color.new(128, 128, 128, 255)
# Set the style to apply changes
entity.style = style

Parameters:

Version:

  • LayOut 2018



994
995
 
# File 'SketchUp/Layout/Style.rb', line 994

def stroke_color=(stroke_color)
end

#stroke_join_style ⇒ Integer?

The #stroke_join_style method returns the stroke join style, or nil if the Layout::Style does not have a value for that setting.

The join style can be one of the following:

Layout::Style::JOIN_STYLE_MITER
Layout::Style::JOIN_STYLE_ROUND
Layout::Style::JOIN_STYLE_BEVEL

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
join_style = style.stroke_join_style

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



1015
1016
 
# File 'SketchUp/Layout/Style.rb', line 1015

def stroke_join_style
end

#stroke_join_style=(join_style) ⇒ Object

The #stroke_join_style= method sets the stroke join style.

The join style can be one of the following:

Layout::Style::JOIN_STYLE_MITER
Layout::Style::JOIN_STYLE_ROUND
Layout::Style::JOIN_STYLE_BEVEL

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.stroke_join_style = Layout::Style::JOIN_STYLE_BEVEL
# Set the style to apply changes
entity.style = style

Parameters:

  • join_style (Integer)

Raises:

  • (ArgumentError) —

    if join_style is not a valid join style

Version:

  • LayOut 2018



1039
1040
 
# File 'SketchUp/Layout/Style.rb', line 1039

def stroke_join_style=(join_style)
end

#stroke_pattern ⇒ Integer?

The #stroke_pattern method returns the stroke pattern, or nil if the Layout::Style does not have a value for that setting.

The stroke pattern can be one of the following:

Layout::Style::STROKE_PATTERN_SOLID
Layout::Style::STROKE_PATTERN_DASH
Layout::Style::STROKE_PATTERN_DOT
Layout::Style::STROKE_PATTERN_DASH_DOT
Layout::Style::STROKE_PATTERN_DASH_DOT_DOT
Layout::Style::STROKE_PATTERN_DASH_SPACE
Layout::Style::STROKE_PATTERN_DASH_DOT_DOT_DOT
Layout::Style::STROKE_PATTERN_DASH_DASH_DOT
Layout::Style::STROKE_PATTERN_DASH_DASH_DOT_DOT
Layout::Style::STROKE_PATTERN_DASH_DASH_DOT_DOT_DOT
Layout::Style::STROKE_PATTERN_CENTER
Layout::Style::STROKE_PATTERN_PHANTOM

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
pattern = style.stroke_pattern

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



1069
1070
 
# File 'SketchUp/Layout/Style.rb', line 1069

def stroke_pattern
end

#stroke_pattern=(pattern) ⇒ Object

The #stroke_pattern= method sets the stroke pattern.

The stroke pattern can be one of the following:

Layout::Style::STROKE_PATTERN_SOLID
Layout::Style::STROKE_PATTERN_DASH
Layout::Style::STROKE_PATTERN_DOT
Layout::Style::STROKE_PATTERN_DASH_DOT
Layout::Style::STROKE_PATTERN_DASH_DOT_DOT
Layout::Style::STROKE_PATTERN_DASH_SPACE
Layout::Style::STROKE_PATTERN_DASH_DOT_DOT_DOT
Layout::Style::STROKE_PATTERN_DASH_DASH_DOT
Layout::Style::STROKE_PATTERN_DASH_DASH_DOT_DOT
Layout::Style::STROKE_PATTERN_DASH_DASH_DOT_DOT_DOT
Layout::Style::STROKE_PATTERN_CENTER
Layout::Style::STROKE_PATTERN_PHANTOM

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.stroke_pattern = Layout::Style::CAP_STYLE_SQUARE
# Set the style to apply changes
entity.style = style

Parameters:

  • pattern (Integer)

Raises:

  • (ArgumentError) —

    if pattern is not a valid stroke pattern

Version:

  • LayOut 2018



1102
1103
 
# File 'SketchUp/Layout/Style.rb', line 1102

def stroke_pattern=(pattern)
end

#stroke_pattern_scale ⇒ Float?

The #stroke_pattern_scale method returns the stroke pattern scale, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
pattern_scale = style.stroke_pattern_scale

Returns:

  • (Float, nil)

Version:

  • LayOut 2018



1118
1119
 
# File 'SketchUp/Layout/Style.rb', line 1118

def stroke_pattern_scale
end

#stroke_pattern_scale=(scale) ⇒ Object

The #stroke_pattern_scale= method sets the stroke pattern scale.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.stroke_pattern_scale = 2.0
# Set the style to apply changes
entity.style = style

Parameters:

  • scale (Float)

Raises:

  • (ArgumentError) —

    if scale is less than 0.1 or greater than 9999.0

Version:

  • LayOut 2018



1137
1138
 
# File 'SketchUp/Layout/Style.rb', line 1137

def stroke_pattern_scale=(scale)
end

#stroke_width ⇒ Float?

The #stroke_width method returns the stroke width, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
stroke_width = style.stroke_width

Returns:

  • (Float, nil)

Version:

  • LayOut 2018



1153
1154
 
# File 'SketchUp/Layout/Style.rb', line 1153

def stroke_width
end

#stroke_width=(stroke_width) ⇒ Object

The #stroke_width= method sets the stroke width.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.stroke_width = 2.0
# Set the style to apply changes
entity.style = style

Parameters:

  • stroke_width (Float)

Raises:

  • (ArgumentError) —

    if stroke_width is less than 0.0

Version:

  • LayOut 2018



1172
1173
 
# File 'SketchUp/Layout/Style.rb', line 1172

def stroke_width=(stroke_width)
end

#stroked ⇒ Boolean?

The #stroked method returns whether the Layout::Style has a stroke, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
has_stroke = style.stroked

Returns:

  • (Boolean, nil)

Version:

  • LayOut 2018



1188
1189
 
# File 'SketchUp/Layout/Style.rb', line 1188

def stroked
end

#stroked=(stroked) ⇒ Object

The #stroked= method sets whether the Layout::Style has a stroke.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.stroked = true
# Set the style to apply changes
entity.style = style

Parameters:

  • stroked (Boolean)

Version:

  • LayOut 2018



1205
1206
 
# File 'SketchUp/Layout/Style.rb', line 1205

def stroked=(stroked)
end

#suppress_dimension_units ⇒ Boolean?

The #suppress_dimension_units method returns whether the units for dimensions are suppressed, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
suppressed = style.suppress_dimension_units

Returns:

  • (Boolean, nil)

Version:

  • LayOut 2018



1222
1223
 
# File 'SketchUp/Layout/Style.rb', line 1222

def suppress_dimension_units
end

#suppress_dimension_units=(suppress) ⇒ Object

The #suppress_dimension_units= method sets whether the units for dimensions are suppressed.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.suppress_dimension_units = true

Parameters:

  • suppress (Boolean)

Version:

  • LayOut 2018



1238
1239
 
# File 'SketchUp/Layout/Style.rb', line 1238

def suppress_dimension_units=(suppress)
end

#text_alignment ⇒ Integer?

The #text_alignment method returns the text alignment, or nil if the Layout::Style does not have a value for that setting.

The alignment type can be one of the following values:

Layout::Style::ALIGN_LEFT
Layout::Style::ALIGN_RIGHT
Layout::Style::ALIGN_CENTER

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
alignment = style.text_alignment

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



1259
1260
 
# File 'SketchUp/Layout/Style.rb', line 1259

def text_alignment
end

#text_alignment=(alignment_type) ⇒ Object

The #text_alignment= method sets the text alignment.

The alignment type can be one of the following values:

Layout::Style::ALIGN_LEFT
Layout::Style::ALIGN_RIGHT
Layout::Style::ALIGN_CENTER

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.text_alignment = Layout::Style::ALIGN_CENTER
# Set the style to apply changes
entity.style = style

Parameters:

  • alignment_type (Integer)

Raises:

  • (ArgumentError) —

    if alignment_type is not a valid alignment type

Version:

  • LayOut 2018



1283
1284
 
# File 'SketchUp/Layout/Style.rb', line 1283

def text_alignment=(alignment_type)
end

#text_anchor ⇒ Integer?

The #text_anchor method returns the text anchor type, or nil if the Layout::Style does not have a value for that setting.

The anchor type can be one of the following values:

Layout::Style::ANCHOR_TOP
Layout::Style::ANCHOR_CENTER
Layout::Style::ANCHOR_BOTTOM

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
anchor_type = style.text_anchor

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



1304
1305
 
# File 'SketchUp/Layout/Style.rb', line 1304

def text_anchor
end

#text_anchor=(anchor_type) ⇒ Object

The #text_anchor= method sets the text anchor type.

The anchor type can be one of the following values:

Layout::Style::ANCHOR_TOP
Layout::Style::ANCHOR_CENTER
Layout::Style::ANCHOR_BOTTOM

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.text_anchor = Layout::Style::ANCHOR_BOTTOM
# Set the style to apply changes
entity.style = style

Parameters:

  • anchor_type (Integer)

Raises:

  • (ArgumentError) —

    if anchor_type is not a valid anchor type

Version:

  • LayOut 2018



1328
1329
 
# File 'SketchUp/Layout/Style.rb', line 1328

def text_anchor=(anchor_type)
end

#text_bold ⇒ Boolean?

The #text_bold method returns whether text is bold, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
bold = style.text_bold

Returns:

  • (Boolean, nil)

Version:

  • LayOut 2018



1344
1345
 
# File 'SketchUp/Layout/Style.rb', line 1344

def text_bold
end

#text_bold=(bold) ⇒ Object

The #text_bold= method sets whether text is bold.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.text_bold = true
# Set the style to apply changes
entity.style = style

Parameters:

  • bold (Boolean)

Version:

  • LayOut 2018



1361
1362
 
# File 'SketchUp/Layout/Style.rb', line 1361

def text_bold=(bold)
end

#text_color ⇒ Sketchup::Color?

The #text_color method returns the text color, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
color = style.text_color

Returns:

Version:

  • LayOut 2018



1377
1378
 
# File 'SketchUp/Layout/Style.rb', line 1377

def text_color
end

#text_color=(color) ⇒ Object

The #text_color= method sets the text color.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.text_color = Sketchup::Color.new(255, 0, 0, 255)
# Set the style to apply changes
entity.style = style

Parameters:

Version:

  • LayOut 2018



1394
1395
 
# File 'SketchUp/Layout/Style.rb', line 1394

def text_color=(color)
end

#text_elevation ⇒ Integer?

The #text_elevation method returns the text elevation, or nil if the Layout::Style does not have a value for that setting.

The elevation type can be one of the following values:

Layout::Style::NORMAL_SCRIPT
Layout::Style::SUPER_SCRIPT
Layout::Style::SUB_SCRIPT

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
elevation = style.text_elevation

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



1415
1416
 
# File 'SketchUp/Layout/Style.rb', line 1415

def text_elevation
end

#text_elevation=(elevation_type) ⇒ Object

The #text_elevation= method sets the text elevation.

The elevation type can be one of the following values:

Layout::Style::NORMAL_SCRIPT
Layout::Style::SUPER_SCRIPT
Layout::Style::SUB_SCRIPT

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.text_elevation = Layout::Style::SUB_SCRIPT
# Set the style to apply changes
entity.style = style

Parameters:

  • elevation_type (Integer)

Raises:

  • (ArgumentError) —

    if elevation_type is not a valid elevation type

Version:

  • LayOut 2018



1439
1440
 
# File 'SketchUp/Layout/Style.rb', line 1439

def text_elevation=(elevation_type)
end

#text_italic ⇒ Boolean?

The #text_italic method returns whether text is italic, or nil if the Layout::Style does not have a value for that setting.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
italic = style.text_italic

Returns:

  • (Boolean, nil)

Version:

  • LayOut 2018



1455
1456
 
# File 'SketchUp/Layout/Style.rb', line 1455

def text_italic
end

#text_italic=(italic) ⇒ Object

The #text_italic= method sets whether text is italic.

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.text_italic = true
# Set the style to apply changes
entity.style = style

Parameters:

  • italic (Boolean)

Version:

  • LayOut 2018



1472
1473
 
# File 'SketchUp/Layout/Style.rb', line 1472

def text_italic=(italic)
end

#text_underline ⇒ Integer?

The #text_underline method returns the text underline type, or nil if the Layout::Style does not have a value for that setting.

The underline type can be one of the following values:

Layout::Style::UNDERLINE_NONE
Layout::Style::UNDERLINE_SINGLE
Layout::Style::UNDERLINE_DOUBLE

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
underline_type = style.text_underline

Returns:

  • (Integer, nil)

Version:

  • LayOut 2018



1493
1494
 
# File 'SketchUp/Layout/Style.rb', line 1493

def text_underline
end

#text_underline=(underline_type) ⇒ Object

The #text_underline= method sets the text underline type.

The underline type can be one of the following values:

Layout::Style::UNDERLINE_NONE
Layout::Style::UNDERLINE_SINGLE
Layout::Style::UNDERLINE_DOUBLE

Examples:

doc = Layout::Document.open("C:/path/to/document.layout")
page = doc.pages.first
entity = page.entities.first
style = entity.style
style.text_underline = Layout::Style::UNDERLINE_DOUBLE
# Set the style to apply changes
entity.style = style

Parameters:

  • underline_type (Integer)

Raises:

  • (ArgumentError) —

    if underline_type is not a valid underline type

Version:

  • LayOut 2018



1517
1518
 
# File 'SketchUp/Layout/Style.rb', line 1517

def text_underline=(underline_type)
end