Data types

List of all data types that may be available in formulas.

String

A text value.

Extends Ruby String class.

Integer

An integer numeric value.

Extends Ruby Integer class.

Float

A decimal value.

Extends Ruby Float class.

Array

A list of objects.

Extends Ruby Array class.

Color

An object that represent a color.

Extends SketchUp Color class.

⚠️ Setter functions are disabled.

ComponentDefinition

An object that represents a SketchUp component definition.

Extends SketchUp ComponentDefinition class.

⚠️ Setter functions are disabled.

Function	Description
get_dc_attribute(key)	Return the custom Dynamic Component attribute referenced by the key name

ComponentInstance

An object that represents a SketchUp component instance.

Extends SketchUp ComponentInstance class.

⚠️ Setter functions are disabled.

Function	Description
get_dc_attribute(key)	Return the custom Dynamic Component attribute referenced by the key name
local_x	Return the x coordinate relative to parent origin (Length)
local_y	Return the y coordinate relative to parent origin (Length)
local_z	Return the z coordinate relative to parent origin (Length)
world_x	Return the x coordinate relative to world origin (Length)
world_y	Return the y coordinate relative to world origin (Length)
world_z	Return the z coordinate relative to world origin (Length)

Length

A numeric value that represents a length.

Extends SketchUp Length class.

Operator	Description
+	Length + Length → (Length)
*	Length * Length → (Area) Length * Area → (Volume)

Area

A numeric value that represents an area.

Extends all Float properties and functions.

Operator	Description
+	Area + Area → (Area)
*	Area * Length → (Volume)

Function	Description
to_mm2	Return area as float value in mm2
to_cm2	Return area as float value in cm2
to_m2	Return area as float value in mm2
to_km2	Return area as float value in km2
to_inch2	Return area as float value in inch2
to_feet2	Return area as float value in feet2
to_mile2	Return area as float value in mile2
to_yard2	Return area as float value in yard2

Volume

A numeric value that represents a volume.

Extends all Float properties and functions.

Operator	Description
+	Volume + Volume → (Volume)

Function	Description
to_mm3	Return volume as float value in mm3
to_cm3	Return volume as float value in cm3
to_m3	Return volume as float value in mm3
to_km3	Return volume as float value in km3
to_inch3	Return volume as float value in inch3
to_feet3	Return volume as float value in feet3
to_mile3	Return volume as float value in mile3
to_yard3	Return volume as float value in yard3
to_fbm	Return volume as float value in FBM

MaterialType

An object that represents a material type.

Function	Description
is_solid_wood?	Return true if material type is Solid Wood
is_sheet_good?	Return true if material type is Sheet Good
is_dimensional?	Return true if material type is Dimensional
is_hardware?	Return true if material type is Hardware
is_edge?	Return true if material type is Edge
is_veneer?	Return true if material type is Veneer
to_i	Return material type as numeric value (Integer)

Material

An object that represents a material.

Property	Description
name	Return the name of the material (String)
color	Return the color of the material (Color)
type	Return the type of the material (MaterialType)
description	Return the description of the material (String)
url	Return the url of the material (String)
std_dimension	Return the standard dimension of the material (String)
std_thickness	Return the standard thickness of the material (Length)
std_width	Return the width of the material (Length)

Function	Description
empty?	Return true if material is "no material"
grained?	Return true if material is grained

Edge

An object that represents an edge.

Extends all Material properties and functions.

Property	Description
material_name	Alias to name
material_color	Alias to color

Veneer

An object that represent a veneer.

Extends all Material properties and functions.

Property	Description
material_name	Alias to name
material_color	Alias to color

Path

An array of instance names.

Extends all Array properties and functions.

Batch

Properties	Description
position	(Integer)
count	(Integer)