sketchup-api-stubs 0.7.3 → 0.7.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.yardopts +9 -9
- data/lib/sketchup-api-stubs.rb +1 -1
- data/lib/sketchup-api-stubs/sketchup.rb +145 -145
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
- data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
- data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
- data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
- data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
- data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
- data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
- data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -514
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
- data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +371 -371
- data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
- data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
- data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +220 -232
- data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
- data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
- data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
- data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
- data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +204 -216
- data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
- data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +694 -694
- data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
- data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
- data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
- data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +140 -140
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -562
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
- data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
- data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1119
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -544
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -280
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1601
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -770
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
- data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
- data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -1301
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/geom.rb +348 -348
- data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
- data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
- data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
- data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/ui.rb +667 -667
- metadata +3 -4
@@ -1,149 +1,149 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# A {Layout::TableCell} is a single cell from a table that contains data.
|
5
|
-
#
|
6
|
-
# @example
|
7
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
8
|
-
# rows = 4
|
9
|
-
# columns = 4
|
10
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
11
|
-
# table.each { |cell|
|
12
|
-
# puts cell.data.plain_text
|
13
|
-
# }
|
14
|
-
#
|
15
|
-
# @version LayOut 2018
|
16
|
-
class Layout::TableCell
|
17
|
-
|
18
|
-
# Constants
|
19
|
-
|
20
|
-
ROTATION_0 = nil # Stub value.
|
21
|
-
ROTATION_180 = nil # Stub value.
|
22
|
-
ROTATION_270 = nil # Stub value.
|
23
|
-
ROTATION_90 = nil # Stub value.
|
24
|
-
|
25
|
-
# Instance Methods
|
26
|
-
|
27
|
-
# The {#data} method creates a copy of the {Layout::FormattedText} for the
|
28
|
-
# {Layout::TableCell}.
|
29
|
-
#
|
30
|
-
# @example
|
31
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
32
|
-
# rows = 4
|
33
|
-
# columns = 4
|
34
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
35
|
-
# cell_entity = table[1, 2].data
|
36
|
-
#
|
37
|
-
# @raise [ArgumentError] if the cell {Layout::Entity} is not a
|
38
|
-
# {Layout::FormattedText}
|
39
|
-
#
|
40
|
-
# @version LayOut 2018
|
41
|
-
def data
|
42
|
-
end
|
43
|
-
|
44
|
-
# The {#data=} method sets the {Layout::Entity} of a {Layout::TableCell}.
|
45
|
-
# The text content and fill {Layout::Style} settings will be kept. The bounds
|
46
|
-
# and other {Layout::Style} settings are controlled by the {Layout::Table}. If
|
47
|
-
# the specified row and column is within a merged cell, then the merged cell
|
48
|
-
# itself will be affected.
|
49
|
-
#
|
50
|
-
# @example
|
51
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
52
|
-
# rows = 4
|
53
|
-
# columns = 4
|
54
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
55
|
-
# anchor = Geom::Point2d.new(1, 1)
|
56
|
-
# text_anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT
|
57
|
-
# text = Layout::FormattedText.new("Test", anchor, text_anchor_type)
|
58
|
-
# table[1, 2].data = text
|
59
|
-
#
|
60
|
-
# @note At the moment, this only works for {Layout::Entity}s that are
|
61
|
-
# {Layout::FormattedText}s. However, future versions of LayOut may support
|
62
|
-
# other types of {Layout::Entity}s for {Layout::TableCell}s, so this method
|
63
|
-
# cannot be assumed to always fail with inputs of other {Layout::Entity}
|
64
|
-
# types.
|
65
|
-
#
|
66
|
-
# @param [Layout::Entity] entity
|
67
|
-
#
|
68
|
-
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
69
|
-
# {Layout::Layer}
|
70
|
-
#
|
71
|
-
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
72
|
-
#
|
73
|
-
# @version LayOut 2018
|
74
|
-
def data=(entity)
|
75
|
-
end
|
76
|
-
|
77
|
-
# The {#rotation} method returns the rotation of a {Layout::TableCell}.
|
78
|
-
#
|
79
|
-
# The rotation type can be one of the following values:
|
80
|
-
# [+Layout::TableCell::ROTATION_0+]
|
81
|
-
# [+Layout::TableCell::ROTATION_90+]
|
82
|
-
# [+Layout::TableCell::ROTATION_180+]
|
83
|
-
# [+Layout::TableCell::ROTATION_270+]
|
84
|
-
#
|
85
|
-
# @example
|
86
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
87
|
-
# rows = 4
|
88
|
-
# columns = 4
|
89
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
90
|
-
# rotation = table[1, 1].rotation
|
91
|
-
#
|
92
|
-
# @raise [ArgumentError] if the cell is invalid due to residing within a
|
93
|
-
# merged cell
|
94
|
-
#
|
95
|
-
# @return [Integer]
|
96
|
-
#
|
97
|
-
# @version LayOut 2018
|
98
|
-
def rotation
|
99
|
-
end
|
100
|
-
|
101
|
-
# The {#rotation=} method sets the rotation of a {Layout::TableCell}.
|
102
|
-
#
|
103
|
-
# The rotation type can be one of the following values:
|
104
|
-
# [+Layout::TableCell::ROTATION_0+]
|
105
|
-
# [+Layout::TableCell::ROTATION_90+]
|
106
|
-
# [+Layout::TableCell::ROTATION_180+]
|
107
|
-
# [+Layout::TableCell::ROTATION_270+]
|
108
|
-
#
|
109
|
-
# @example
|
110
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
111
|
-
# rows = 4
|
112
|
-
# columns = 4
|
113
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
114
|
-
# table[1, 1].rotation = Layout::TableCell::ROTATION_180
|
115
|
-
#
|
116
|
-
# @param [Integer] cell_rotation
|
117
|
-
#
|
118
|
-
# @raise [ArgumentError] if the cell is invalid due to residing within a
|
119
|
-
# merged cell
|
120
|
-
#
|
121
|
-
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
122
|
-
# {Layout::Layer}
|
123
|
-
#
|
124
|
-
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
125
|
-
#
|
126
|
-
# @version LayOut 2018
|
127
|
-
def rotation=(cell_rotation)
|
128
|
-
end
|
129
|
-
|
130
|
-
# The {#span} method returns the row and column span of a {Layout::TableCell}.
|
131
|
-
# If the values returned are both 1, then it is a normal, non-merged cell. If
|
132
|
-
# either of the values are greater than 1, then it is a merged cell. If the
|
133
|
-
# values are both 0, then it is an unused cell that resides within the inner
|
134
|
-
# portion of another merged cell.
|
135
|
-
#
|
136
|
-
# @example
|
137
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
138
|
-
# rows = 4
|
139
|
-
# columns = 4
|
140
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
141
|
-
# row_span, column_span = table[1, 1].span
|
142
|
-
#
|
143
|
-
# @return [Array(Integer, Integer)] Row span and column span.
|
144
|
-
#
|
145
|
-
# @version LayOut 2018
|
146
|
-
def span
|
147
|
-
end
|
148
|
-
|
149
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# A {Layout::TableCell} is a single cell from a table that contains data.
|
5
|
+
#
|
6
|
+
# @example
|
7
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
8
|
+
# rows = 4
|
9
|
+
# columns = 4
|
10
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
11
|
+
# table.each { |cell|
|
12
|
+
# puts cell.data.plain_text
|
13
|
+
# }
|
14
|
+
#
|
15
|
+
# @version LayOut 2018
|
16
|
+
class Layout::TableCell
|
17
|
+
|
18
|
+
# Constants
|
19
|
+
|
20
|
+
ROTATION_0 = nil # Stub value.
|
21
|
+
ROTATION_180 = nil # Stub value.
|
22
|
+
ROTATION_270 = nil # Stub value.
|
23
|
+
ROTATION_90 = nil # Stub value.
|
24
|
+
|
25
|
+
# Instance Methods
|
26
|
+
|
27
|
+
# The {#data} method creates a copy of the {Layout::FormattedText} for the
|
28
|
+
# {Layout::TableCell}.
|
29
|
+
#
|
30
|
+
# @example
|
31
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
32
|
+
# rows = 4
|
33
|
+
# columns = 4
|
34
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
35
|
+
# cell_entity = table[1, 2].data
|
36
|
+
#
|
37
|
+
# @raise [ArgumentError] if the cell {Layout::Entity} is not a
|
38
|
+
# {Layout::FormattedText}
|
39
|
+
#
|
40
|
+
# @version LayOut 2018
|
41
|
+
def data
|
42
|
+
end
|
43
|
+
|
44
|
+
# The {#data=} method sets the {Layout::Entity} of a {Layout::TableCell}.
|
45
|
+
# The text content and fill {Layout::Style} settings will be kept. The bounds
|
46
|
+
# and other {Layout::Style} settings are controlled by the {Layout::Table}. If
|
47
|
+
# the specified row and column is within a merged cell, then the merged cell
|
48
|
+
# itself will be affected.
|
49
|
+
#
|
50
|
+
# @example
|
51
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
52
|
+
# rows = 4
|
53
|
+
# columns = 4
|
54
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
55
|
+
# anchor = Geom::Point2d.new(1, 1)
|
56
|
+
# text_anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT
|
57
|
+
# text = Layout::FormattedText.new("Test", anchor, text_anchor_type)
|
58
|
+
# table[1, 2].data = text
|
59
|
+
#
|
60
|
+
# @note At the moment, this only works for {Layout::Entity}s that are
|
61
|
+
# {Layout::FormattedText}s. However, future versions of LayOut may support
|
62
|
+
# other types of {Layout::Entity}s for {Layout::TableCell}s, so this method
|
63
|
+
# cannot be assumed to always fail with inputs of other {Layout::Entity}
|
64
|
+
# types.
|
65
|
+
#
|
66
|
+
# @param [Layout::Entity] entity
|
67
|
+
#
|
68
|
+
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
69
|
+
# {Layout::Layer}
|
70
|
+
#
|
71
|
+
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
72
|
+
#
|
73
|
+
# @version LayOut 2018
|
74
|
+
def data=(entity)
|
75
|
+
end
|
76
|
+
|
77
|
+
# The {#rotation} method returns the rotation of a {Layout::TableCell}.
|
78
|
+
#
|
79
|
+
# The rotation type can be one of the following values:
|
80
|
+
# [+Layout::TableCell::ROTATION_0+]
|
81
|
+
# [+Layout::TableCell::ROTATION_90+]
|
82
|
+
# [+Layout::TableCell::ROTATION_180+]
|
83
|
+
# [+Layout::TableCell::ROTATION_270+]
|
84
|
+
#
|
85
|
+
# @example
|
86
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
87
|
+
# rows = 4
|
88
|
+
# columns = 4
|
89
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
90
|
+
# rotation = table[1, 1].rotation
|
91
|
+
#
|
92
|
+
# @raise [ArgumentError] if the cell is invalid due to residing within a
|
93
|
+
# merged cell
|
94
|
+
#
|
95
|
+
# @return [Integer]
|
96
|
+
#
|
97
|
+
# @version LayOut 2018
|
98
|
+
def rotation
|
99
|
+
end
|
100
|
+
|
101
|
+
# The {#rotation=} method sets the rotation of a {Layout::TableCell}.
|
102
|
+
#
|
103
|
+
# The rotation type can be one of the following values:
|
104
|
+
# [+Layout::TableCell::ROTATION_0+]
|
105
|
+
# [+Layout::TableCell::ROTATION_90+]
|
106
|
+
# [+Layout::TableCell::ROTATION_180+]
|
107
|
+
# [+Layout::TableCell::ROTATION_270+]
|
108
|
+
#
|
109
|
+
# @example
|
110
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
111
|
+
# rows = 4
|
112
|
+
# columns = 4
|
113
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
114
|
+
# table[1, 1].rotation = Layout::TableCell::ROTATION_180
|
115
|
+
#
|
116
|
+
# @param [Integer] cell_rotation
|
117
|
+
#
|
118
|
+
# @raise [ArgumentError] if the cell is invalid due to residing within a
|
119
|
+
# merged cell
|
120
|
+
#
|
121
|
+
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
122
|
+
# {Layout::Layer}
|
123
|
+
#
|
124
|
+
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
125
|
+
#
|
126
|
+
# @version LayOut 2018
|
127
|
+
def rotation=(cell_rotation)
|
128
|
+
end
|
129
|
+
|
130
|
+
# The {#span} method returns the row and column span of a {Layout::TableCell}.
|
131
|
+
# If the values returned are both 1, then it is a normal, non-merged cell. If
|
132
|
+
# either of the values are greater than 1, then it is a merged cell. If the
|
133
|
+
# values are both 0, then it is an unused cell that resides within the inner
|
134
|
+
# portion of another merged cell.
|
135
|
+
#
|
136
|
+
# @example
|
137
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
138
|
+
# rows = 4
|
139
|
+
# columns = 4
|
140
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
141
|
+
# row_span, column_span = table[1, 1].span
|
142
|
+
#
|
143
|
+
# @return [Array(Integer, Integer)] Row span and column span.
|
144
|
+
#
|
145
|
+
# @version LayOut 2018
|
146
|
+
def span
|
147
|
+
end
|
148
|
+
|
149
|
+
end
|
@@ -1,139 +1,139 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# A {Layout::TableColumn} is a single column from a table.
|
5
|
-
#
|
6
|
-
# @example
|
7
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
8
|
-
# rows = 4
|
9
|
-
# columns = 4
|
10
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
11
|
-
# columns.times { |index|
|
12
|
-
# column = table.column(index)
|
13
|
-
# }
|
14
|
-
#
|
15
|
-
# @version LayOut 2018
|
16
|
-
class Layout::TableColumn
|
17
|
-
|
18
|
-
# Instance Methods
|
19
|
-
|
20
|
-
# The {#left_edge_style} method returns the {Layout::Style} of a
|
21
|
-
# {Layout::TableColumn}'s left edge. If this is the first column of the table,
|
22
|
-
# this method will return the style of the table border.
|
23
|
-
#
|
24
|
-
# @example
|
25
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
26
|
-
# rows = 4
|
27
|
-
# columns = 4
|
28
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
29
|
-
# style = table.get_column(1).edge_style
|
30
|
-
#
|
31
|
-
# @return [Layout::Style]
|
32
|
-
#
|
33
|
-
# @version LayOut 2018
|
34
|
-
def left_edge_style
|
35
|
-
end
|
36
|
-
|
37
|
-
# The {#left_edge_style=} method sets the {Layout::Style} of a
|
38
|
-
# {Layout::TableColumn}'s left edge. If this is the first column of the table,
|
39
|
-
# this method will set the style for the table border.
|
40
|
-
#
|
41
|
-
# @example
|
42
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
43
|
-
# rows = 4
|
44
|
-
# columns = 4
|
45
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
46
|
-
# style = Layout::Style.new
|
47
|
-
# style.stroke_width = 2.0
|
48
|
-
# table.get_column(1).edge_style = style
|
49
|
-
#
|
50
|
-
# @param [Layout::Style] style
|
51
|
-
#
|
52
|
-
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
53
|
-
# {Layout::Layer}
|
54
|
-
#
|
55
|
-
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
56
|
-
#
|
57
|
-
# @version LayOut 2018
|
58
|
-
def left_edge_style=(style)
|
59
|
-
end
|
60
|
-
|
61
|
-
# The {#right_edge_style} method returns the {Layout::Style} of a
|
62
|
-
# {Layout::TableColumn}'s right edge. If this is the last column of the table,
|
63
|
-
# this method will return the style of the table border.
|
64
|
-
#
|
65
|
-
# @example
|
66
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
67
|
-
# rows = 4
|
68
|
-
# columns = 4
|
69
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
70
|
-
# style = table.get_column(1).edge_style
|
71
|
-
#
|
72
|
-
# @return [Layout::Style]
|
73
|
-
#
|
74
|
-
# @version LayOut 2018
|
75
|
-
def right_edge_style
|
76
|
-
end
|
77
|
-
|
78
|
-
# The {#right_edge_style=} method sets the {Layout::Style} of a
|
79
|
-
# {Layout::TableColumn}'s right edge. If this is the last column of the table,
|
80
|
-
# this method will set the style for the table border.
|
81
|
-
#
|
82
|
-
# @example
|
83
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
84
|
-
# rows = 4
|
85
|
-
# columns = 4
|
86
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
87
|
-
# style = Layout::Style.new
|
88
|
-
# style.stroke_width = 2.0
|
89
|
-
# table.get_column(1).edge_style = style
|
90
|
-
#
|
91
|
-
# @param [Layout::Style] style
|
92
|
-
#
|
93
|
-
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
94
|
-
# {Layout::Layer}
|
95
|
-
#
|
96
|
-
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
97
|
-
#
|
98
|
-
# @version LayOut 2018
|
99
|
-
def right_edge_style=(style)
|
100
|
-
end
|
101
|
-
|
102
|
-
# The {#width} method returns the width of the {Layout::TableColumn}.
|
103
|
-
#
|
104
|
-
# @example
|
105
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
106
|
-
# rows = 4
|
107
|
-
# columns = 4
|
108
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
109
|
-
# width = table.get_column(1).width
|
110
|
-
#
|
111
|
-
# @return [Float]
|
112
|
-
#
|
113
|
-
# @version LayOut 2018
|
114
|
-
def width
|
115
|
-
end
|
116
|
-
|
117
|
-
# The {#width=} method sets the width of the {Layout::TableColumn}.
|
118
|
-
#
|
119
|
-
# @example
|
120
|
-
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
121
|
-
# rows = 4
|
122
|
-
# columns = 4
|
123
|
-
# table = Layout::Table.new(bounds, rows, columns)
|
124
|
-
# table.get_column(1).width = 6.0
|
125
|
-
#
|
126
|
-
# @param [Float] width
|
127
|
-
#
|
128
|
-
# @raise [ArgumentError] if width is not a valid width
|
129
|
-
#
|
130
|
-
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
131
|
-
# {Layout::Layer}
|
132
|
-
#
|
133
|
-
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
134
|
-
#
|
135
|
-
# @version LayOut 2018
|
136
|
-
def width=(width)
|
137
|
-
end
|
138
|
-
|
139
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# A {Layout::TableColumn} is a single column from a table.
|
5
|
+
#
|
6
|
+
# @example
|
7
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
8
|
+
# rows = 4
|
9
|
+
# columns = 4
|
10
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
11
|
+
# columns.times { |index|
|
12
|
+
# column = table.column(index)
|
13
|
+
# }
|
14
|
+
#
|
15
|
+
# @version LayOut 2018
|
16
|
+
class Layout::TableColumn
|
17
|
+
|
18
|
+
# Instance Methods
|
19
|
+
|
20
|
+
# The {#left_edge_style} method returns the {Layout::Style} of a
|
21
|
+
# {Layout::TableColumn}'s left edge. If this is the first column of the table,
|
22
|
+
# this method will return the style of the table border.
|
23
|
+
#
|
24
|
+
# @example
|
25
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
26
|
+
# rows = 4
|
27
|
+
# columns = 4
|
28
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
29
|
+
# style = table.get_column(1).edge_style
|
30
|
+
#
|
31
|
+
# @return [Layout::Style]
|
32
|
+
#
|
33
|
+
# @version LayOut 2018
|
34
|
+
def left_edge_style
|
35
|
+
end
|
36
|
+
|
37
|
+
# The {#left_edge_style=} method sets the {Layout::Style} of a
|
38
|
+
# {Layout::TableColumn}'s left edge. If this is the first column of the table,
|
39
|
+
# this method will set the style for the table border.
|
40
|
+
#
|
41
|
+
# @example
|
42
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
43
|
+
# rows = 4
|
44
|
+
# columns = 4
|
45
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
46
|
+
# style = Layout::Style.new
|
47
|
+
# style.stroke_width = 2.0
|
48
|
+
# table.get_column(1).edge_style = style
|
49
|
+
#
|
50
|
+
# @param [Layout::Style] style
|
51
|
+
#
|
52
|
+
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
53
|
+
# {Layout::Layer}
|
54
|
+
#
|
55
|
+
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
56
|
+
#
|
57
|
+
# @version LayOut 2018
|
58
|
+
def left_edge_style=(style)
|
59
|
+
end
|
60
|
+
|
61
|
+
# The {#right_edge_style} method returns the {Layout::Style} of a
|
62
|
+
# {Layout::TableColumn}'s right edge. If this is the last column of the table,
|
63
|
+
# this method will return the style of the table border.
|
64
|
+
#
|
65
|
+
# @example
|
66
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
67
|
+
# rows = 4
|
68
|
+
# columns = 4
|
69
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
70
|
+
# style = table.get_column(1).edge_style
|
71
|
+
#
|
72
|
+
# @return [Layout::Style]
|
73
|
+
#
|
74
|
+
# @version LayOut 2018
|
75
|
+
def right_edge_style
|
76
|
+
end
|
77
|
+
|
78
|
+
# The {#right_edge_style=} method sets the {Layout::Style} of a
|
79
|
+
# {Layout::TableColumn}'s right edge. If this is the last column of the table,
|
80
|
+
# this method will set the style for the table border.
|
81
|
+
#
|
82
|
+
# @example
|
83
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
84
|
+
# rows = 4
|
85
|
+
# columns = 4
|
86
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
87
|
+
# style = Layout::Style.new
|
88
|
+
# style.stroke_width = 2.0
|
89
|
+
# table.get_column(1).edge_style = style
|
90
|
+
#
|
91
|
+
# @param [Layout::Style] style
|
92
|
+
#
|
93
|
+
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
94
|
+
# {Layout::Layer}
|
95
|
+
#
|
96
|
+
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
97
|
+
#
|
98
|
+
# @version LayOut 2018
|
99
|
+
def right_edge_style=(style)
|
100
|
+
end
|
101
|
+
|
102
|
+
# The {#width} method returns the width of the {Layout::TableColumn}.
|
103
|
+
#
|
104
|
+
# @example
|
105
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
106
|
+
# rows = 4
|
107
|
+
# columns = 4
|
108
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
109
|
+
# width = table.get_column(1).width
|
110
|
+
#
|
111
|
+
# @return [Float]
|
112
|
+
#
|
113
|
+
# @version LayOut 2018
|
114
|
+
def width
|
115
|
+
end
|
116
|
+
|
117
|
+
# The {#width=} method sets the width of the {Layout::TableColumn}.
|
118
|
+
#
|
119
|
+
# @example
|
120
|
+
# bounds = Geom::Bounds2d.new(1, 1, 4, 4)
|
121
|
+
# rows = 4
|
122
|
+
# columns = 4
|
123
|
+
# table = Layout::Table.new(bounds, rows, columns)
|
124
|
+
# table.get_column(1).width = 6.0
|
125
|
+
#
|
126
|
+
# @param [Float] width
|
127
|
+
#
|
128
|
+
# @raise [ArgumentError] if width is not a valid width
|
129
|
+
#
|
130
|
+
# @raise [LockedLayerError] if the {Layout::Table} is on a locked
|
131
|
+
# {Layout::Layer}
|
132
|
+
#
|
133
|
+
# @raise [LockedEntityError] if the {Layout::Table} is locked
|
134
|
+
#
|
135
|
+
# @version LayOut 2018
|
136
|
+
def width=(width)
|
137
|
+
end
|
138
|
+
|
139
|
+
end
|