sketchup-api-stubs 0.7.9 → 0.7.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (160) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +157 -151
  3. data/lib/sketchup-api-stubs/stubs/Array.rb +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +182 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +111 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +423 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +693 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +535 -509
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +500 -476
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +267 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +133 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +547 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +678 -693
  16. data/lib/sketchup-api-stubs/stubs/Geom.rb +351 -351
  17. data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +93 -93
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -595
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +751 -747
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -183
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Dictionary.rb +234 -0
  23. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +683 -517
  24. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
  26. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +464 -353
  27. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -354
  28. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  29. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  30. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  31. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
  32. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  33. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  34. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
  35. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +614 -567
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  37. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  38. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +282 -183
  39. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +458 -387
  40. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
  41. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +346 -344
  42. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  43. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -82
  44. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +714 -692
  45. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1565 -1519
  46. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  49. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  50. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  51. data/lib/sketchup-api-stubs/stubs/Length.rb +286 -278
  52. data/lib/sketchup-api-stubs/stubs/Numeric.rb +249 -249
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +196 -144
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -169
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +226 -209
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +145 -150
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +294 -281
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +296 -302
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +473 -478
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -121
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +673 -659
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +600 -593
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +252 -257
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +443 -449
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +167 -165
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +403 -406
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -397
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1282 -1239
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -261
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +519 -545
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Environment.rb +406 -0
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Environments.rb +185 -0
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/EnvironmentsObserver.rb +113 -0
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +122 -125
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +1006 -937
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -102
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +740 -750
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +289 -282
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +64 -62
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +405 -468
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +432 -406
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +307 -306
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +332 -326
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +380 -422
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +409 -427
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +241 -249
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +55 -48
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -114
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/LoadHandler.rb +70 -0
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +1115 -414
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +330 -317
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1714 -1652
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +372 -357
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +133 -130
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -271
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +463 -490
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +104 -116
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +939 -797
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +388 -361
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +501 -478
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +385 -361
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +451 -458
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +211 -212
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +259 -255
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Snap.rb +125 -0
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +88 -69
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +263 -217
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +283 -262
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +199 -217
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +924 -834
  143. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  144. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
  145. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -75
  146. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +143 -142
  147. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1566 -1311
  148. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +71 -45
  149. data/lib/sketchup-api-stubs/stubs/Sketchup.rb +1429 -1377
  150. data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +353 -353
  151. data/lib/sketchup-api-stubs/stubs/String.rb +24 -24
  152. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +399 -389
  153. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +580 -494
  154. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +280 -269
  155. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +258 -241
  156. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +636 -635
  157. data/lib/sketchup-api-stubs/stubs/UI.rb +791 -683
  158. data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -303
  159. data/lib/sketchup-api-stubs.rb +1 -1
  160. metadata +10 -24
@@ -1,370 +1,370 @@
1
- # Copyright:: Copyright 2023 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This is an interface to a label entity. A {Layout::Label} consists of a
5
- # {Layout::FormattedText} and the label leader {Layout::Path}. A
6
- # {Layout::Label} may be connected to another {Layout::Entity} via a
7
- # {Layout::ConnectionPoint}.
8
- #
9
- # @version LayOut 2018
10
- class Layout::Label < Layout::Entity
11
-
12
- # Constants
13
-
14
- CONNECTION_TYPE_AUTO = nil # Stub value.
15
- CONNECTION_TYPE_BOTTOM_LEFT = nil # Stub value.
16
- CONNECTION_TYPE_BOTTOM_RIGHT = nil # Stub value.
17
- CONNECTION_TYPE_CENTER_LEFT = nil # Stub value.
18
- CONNECTION_TYPE_CENTER_RIGHT = nil # Stub value.
19
- CONNECTION_TYPE_NONE = nil # Stub value.
20
- CONNECTION_TYPE_REVERSE_AUTO = nil # Stub value.
21
- CONNECTION_TYPE_TOP_LEFT = nil # Stub value.
22
- CONNECTION_TYPE_TOP_RIGHT = nil # Stub value.
23
-
24
- LEADER_LINE_TYPE_BEZIER = nil # Stub value.
25
- LEADER_LINE_TYPE_SINGLE_SEGMENT = nil # Stub value.
26
- LEADER_LINE_TYPE_TWO_SEGMENT = nil # Stub value.
27
- LEADER_LINE_TYPE_UNKNOWN = nil # Stub value.
28
-
29
- # Instance Methods
30
-
31
- # The {#connect} method connects the {Layout::Label} to the given
32
- # {Layout::ConnectionPoint}. The leader line will be adjusted to point at the
33
- # {Layout::ConnectionPoint}. The {Layout::Label} must be in the same
34
- # {Layout::Document} as the {Layout::ConnectionPoint}. If both the
35
- # {Layout::Label} and the {Layout::ConnectionPoint}'s {Layout::Entity} are on
36
- # non-shared {Layout::Layer}s, they must be on the same {Layout::Page}.
37
- #
38
- # @example
39
- # text = "A label"
40
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
41
- # target_point = Geom::Point2d.new(1, 1)
42
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
43
- # label = Layout::Label.new(text, leader_type, target_point, bounds)
44
- # rect = Layout::Rectangle.new([4, 4, 4, 4])
45
- #
46
- # doc = Layout::Document.new
47
- # doc.add_entity(label, doc.layers.first, doc.pages.first)
48
- # doc.add_entity(rect, doc.layers.first, doc.pages.first)
49
- #
50
- # point = Geom::Point2d.new(4, 4)
51
- # # Create a Connection Point to a LayOut Entity in the Document
52
- # cp = Layout::ConnectionPoint.new(rect, point)
53
- # label.connect(cp)
54
- #
55
- # @param [Layout::ConnectionPoint] connection_point
56
- #
57
- # @raise [LockedLayerError] if the {Layout::Label} is on a locked
58
- # {Layout::Layer}
59
- #
60
- # @raise [LockedEntityError] if the {Layout::Label} is locked
61
- #
62
- # @raise [ArgumentError] if the {Layout::Label} is not in the same
63
- # {Layout::Document} as the {Layout::ConnectionPoint}
64
- #
65
- # @raise [ArgumentError] if both the {Layout::Label} and the
66
- # {Layout::ConnectionPoint} are on non-shared {Layout::Layers}, but are not
67
- # on the same {Layout::Page}.
68
- #
69
- # @version LayOut 2018
70
- def connect(connection_point)
71
- end
72
-
73
- # The {#connection_type} method returns the type of the text connection for the
74
- # {Layout::Label}.
75
- #
76
- # The leader line type can be one of the following values:
77
- # [+Layout::Label::CONNECTION_TYPE_NONE+]
78
- # [+Layout::Label::CONNECTION_TYPE_AUTO+]
79
- # [+Layout::Label::CONNECTION_TYPE_REVERSE_AUTO+]
80
- # [+Layout::Label::CONNECTION_TYPE_TOP_LEFT+]
81
- # [+Layout::Label::CONNECTION_TYPE_CENTER_LEFT+]
82
- # [+Layout::Label::CONNECTION_TYPE_BOTTOM_LEFT+]
83
- # [+Layout::Label::CONNECTION_TYPE_TOP_RIGHT+]
84
- # [+Layout::Label::CONNECTION_TYPE_CENTER_RIGHT+]
85
- # [+Layout::Label::CONNECTION_TYPE_BOTTOM_RIGHT+]
86
- #
87
- # @example
88
- # text = "A label"
89
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
90
- # target_point = Geom::Point2d.new(1, 1)
91
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
92
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
93
- # bounds)
94
- # text_connection_type = label_from_bounds.connection_type
95
- #
96
- # @return [Integer]
97
- #
98
- # @version LayOut 2018
99
- def connection_type
100
- end
101
-
102
- # The {#connection_type=} method sets the type of the text connection for the
103
- # {Layout::Label}.
104
- #
105
- # The leader line type can be one of the following values:
106
- # [+Layout::Label::CONNECTION_TYPE_NONE+]
107
- # [+Layout::Label::CONNECTION_TYPE_AUTO+]
108
- # [+Layout::Label::CONNECTION_TYPE_REVERSE_AUTO+]
109
- # [+Layout::Label::CONNECTION_TYPE_TOP_LEFT+]
110
- # [+Layout::Label::CONNECTION_TYPE_CENTER_LEFT+]
111
- # [+Layout::Label::CONNECTION_TYPE_BOTTOM_LEFT+]
112
- # [+Layout::Label::CONNECTION_TYPE_TOP_RIGHT+]
113
- # [+Layout::Label::CONNECTION_TYPE_CENTER_RIGHT+]
114
- # [+Layout::Label::CONNECTION_TYPE_BOTTOM_RIGHT+]
115
- #
116
- # @example
117
- # text = "A label"
118
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
119
- # target_point = Geom::Point2d.new(1, 1)
120
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
121
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
122
- # bounds)
123
- # label_from_bounds.connection_type = Layout::Label::CONNECTION_TYPE_TOP_LEFT
124
- #
125
- # @param [Integer] connection_type
126
- #
127
- # @raise [LockedLayerError] if the {Layout::Label} is on a locked
128
- # {Layout::Layer}
129
- #
130
- # @raise [LockedEntityError] if the {Layout::Label} is locked
131
- #
132
- # @raise [ArgumentError] if the connection_type is not a valid text connection
133
- # type
134
- #
135
- # @version LayOut 2018
136
- def connection_type=(connection_type)
137
- end
138
-
139
- # The {#disconnect} method disconnects the {Layout::Label} from its
140
- # {Layout::ConnectionPoint}. The leader line will not be adjusted by
141
- # disconnecting from a {Layout::ConnectionPoint}.
142
- #
143
- # @example
144
- # doc = Layout::Document.open("C:/path/to/document.layout")
145
- # label = doc.pages.first.entities.first
146
- # label.disconnect
147
- #
148
- # @raise [LockedLayerError] if the {Layout::Label} is on a locked
149
- # {Layout::Layer}
150
- #
151
- # @raise [LockedEntityError] if the {Layout::Label} is locked
152
- #
153
- # @version LayOut 2018
154
- def disconnect
155
- end
156
-
157
- # The {#entities} method returns the {Layout::Entities} that represent the
158
- # {Layout::Label} in its exploded form.
159
- #
160
- # @example
161
- # text = "A label"
162
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
163
- # target_point = Geom::Point2d.new(1, 1)
164
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
165
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
166
- # bounds)
167
- # entities = label_from_bounds.entities
168
- #
169
- # @overload entities
170
- #
171
- # @return [Layout::Entities]
172
- #
173
- # @overload entities(page)
174
- #
175
- # @param [Layout::Page] page The {Layout::Page} to use to convert an
176
- # auto-text tag to display text
177
- # @return [Layout::Entities]
178
- #
179
- # @raise [ArgumentError] if page does not belong to the same document as the
180
- # [Layout::Label]
181
- #
182
- # @version LayOut 2018
183
- def entities(*args)
184
- end
185
-
186
- # The {#initialize} method creates a new disconnected {Layout::Label}.
187
- #
188
- # @example
189
- # text = "A label"
190
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
191
- # target_point = Geom::Point2d.new(1, 1)
192
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
193
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
194
- # bounds)
195
- # anchor_point = Geom::Point2d.new(2, 2)
196
- # anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_RIGHT
197
- # label_from_point = Layout::Label.new(text, leader_type, target_point,
198
- # anchor_point, anchor_type)
199
- #
200
- # @overload initialize(text, leader_type, target_point, bounds)
201
- #
202
- # @param [String] text The label text
203
- # @param [Integer] leader_type The leader line type
204
- # @param [Geom::Point2d] target_point Where the label leader should point to
205
- # @param [Geom::Bounds2d] bounds
206
- # @return [Layout::Label]
207
- #
208
- # @overload initialize(text, leader_type, target_point, anchor_point, anchor_type)
209
- #
210
- # @param [String] text The label text
211
- # @param [Integer] leader_type The leader line type
212
- # @param [Geom::Point2d] target_point Where the label leader should point to
213
- # @param [Geom::Point2d] anchor_point The anchor point for the label text's
214
- # position.
215
- # @param [Integer] anchor_type Defines which point of the label text is set
216
- # by anchor_point.
217
- # @return [Layout::Label]
218
- #
219
- # @raise [ArgumentError] if anchor_type is not a valid anchor type
220
- #
221
- # @raise [ArgumentError] if leader_type is not a valid leader line type
222
- #
223
- # @raise [ArgumentError] if bounds is zero size
224
- #
225
- # @raise [ArgumentError] if plain_text is an empty string
226
- #
227
- # @version LayOut 2018
228
- def initialize(*args)
229
- end
230
-
231
- # The {#leader_line} method returns a copy of the leader line.
232
- #
233
- # @example
234
- # text = "A label"
235
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
236
- # target_point = Geom::Point2d.new(1, 1)
237
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
238
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
239
- # bounds)
240
- # leader = label_from_bounds.leader_line
241
- #
242
- # @return [Layout::Path]
243
- #
244
- # @version LayOut 2018
245
- def leader_line
246
- end
247
-
248
- # The {#leader_line=} method sets the leader line.
249
- #
250
- # @example
251
- # text = "A label"
252
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
253
- # target_point = Geom::Point2d.new(1, 1)
254
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
255
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
256
- # bounds)
257
- # path = Layout::Path.new(Geom::Point2d.new(1, 2), Geom::Point2d.new(2, 3))
258
- # label_from_bounds.leader_line = path
259
- #
260
- # @param [Layout::Path] leader_path
261
- #
262
- # @raise [LockedLayerError] if the {Layout::Label} is on a locked
263
- # {Layout::Layer}
264
- #
265
- # @raise [LockedEntityError] if the {Layout::Label} is locked
266
- #
267
- # @version LayOut 2018
268
- def leader_line=(leader_path)
269
- end
270
-
271
- # The {#leader_line_type} method returns the type of the leader line for the
272
- # {Layout::Label}.
273
- #
274
- # The leader line type can be one of the following values:
275
- # [+Layout::Label::LEADER_LINE_TYPE_SINGLE_SEGMENT+]
276
- # [+Layout::Label::LEADER_LINE_TYPE_TWO_SEGMENT+]
277
- # [+Layout::Label::LEADER_LINE_TYPE_BEZIER+]
278
- # [+Layout::Label::LEADER_LINE_TYPE_UNKNOWN+]
279
- #
280
- # @example
281
- # text = "A label"
282
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
283
- # target_point = Geom::Point2d.new(1, 1)
284
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
285
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
286
- # bounds)
287
- # leader_type = label_from_bounds.leader_line_type
288
- #
289
- # @return [Integer]
290
- #
291
- # @version LayOut 2018
292
- def leader_line_type
293
- end
294
-
295
- # The {#leader_line_type=} method sets the type of the leader line for the
296
- # {Layout::Label}.
297
- #
298
- # The leader line type can be one of the following values:
299
- # [+Layout::Label::LEADER_LINE_TYPE_SINGLE_SEGMENT+]
300
- # [+Layout::Label::LEADER_LINE_TYPE_TWO_SEGMENT+]
301
- # [+Layout::Label::LEADER_LINE_TYPE_BEZIER+]
302
- # [+Layout::Label::LEADER_LINE_TYPE_UNKNOWN+]
303
- #
304
- # @example
305
- # text = "A label"
306
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
307
- # target_point = Geom::Point2d.new(1, 1)
308
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
309
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
310
- # bounds)
311
- # label_from_bounds.leader_line_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
312
- #
313
- # @param [Integer] leader_type
314
- #
315
- # @raise [LockedLayerError] if the {Layout::Label} is on a locked
316
- # {Layout::Layer}
317
- #
318
- # @raise [LockedEntityError] if the {Layout::Label} is locked
319
- #
320
- # @raise [ArgumentError] if leader_type is
321
- # +Layout::Label::LEADER_LINE_TYPE_UNKNOWN+ or not a valid leader line type
322
- #
323
- # @version LayOut 2018
324
- def leader_line_type=(leader_type)
325
- end
326
-
327
- # The {#text} method returns a copy of the {Layout::FormattedText} of the
328
- # {Layout::Label}.
329
- #
330
- # @example
331
- # text = "A label"
332
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
333
- # target_point = Geom::Point2d.new(1, 1)
334
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
335
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
336
- # bounds)
337
- # text = label_from_bounds.text
338
- #
339
- # @return [Layout::FormattedText]
340
- #
341
- # @version LayOut 2018
342
- def text
343
- end
344
-
345
- # The {#text=} method sets the {Layout::FormattedText} of the {Layout::Label}.
346
- #
347
- # @example
348
- # text = "A label"
349
- # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
350
- # target_point = Geom::Point2d.new(1, 1)
351
- # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
352
- # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
353
- # bounds)
354
- # anchor = Geom::Point2d.new(1, 1)
355
- # anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT
356
- # text = Layout::FormattedText.new("Test", anchor, anchor_type)
357
- # label_from_bounds.text = text
358
- #
359
- # @param [Layout::FormattedText] new_text
360
- #
361
- # @raise [LockedLayerError] if the {Layout::Label} is on a locked
362
- # {Layout::Layer}
363
- #
364
- # @raise [LockedEntityError] if the {Layout::Label} is locked
365
- #
366
- # @version LayOut 2018
367
- def text=(new_text)
368
- end
369
-
370
- end
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This is an interface to a label entity. A {Layout::Label} consists of a
5
+ # {Layout::FormattedText} and the label leader {Layout::Path}. A
6
+ # {Layout::Label} may be connected to another {Layout::Entity} via a
7
+ # {Layout::ConnectionPoint}.
8
+ #
9
+ # @version LayOut 2018
10
+ class Layout::Label < Layout::Entity
11
+
12
+ # Constants
13
+
14
+ CONNECTION_TYPE_AUTO = nil # Stub value.
15
+ CONNECTION_TYPE_BOTTOM_LEFT = nil # Stub value.
16
+ CONNECTION_TYPE_BOTTOM_RIGHT = nil # Stub value.
17
+ CONNECTION_TYPE_CENTER_LEFT = nil # Stub value.
18
+ CONNECTION_TYPE_CENTER_RIGHT = nil # Stub value.
19
+ CONNECTION_TYPE_NONE = nil # Stub value.
20
+ CONNECTION_TYPE_REVERSE_AUTO = nil # Stub value.
21
+ CONNECTION_TYPE_TOP_LEFT = nil # Stub value.
22
+ CONNECTION_TYPE_TOP_RIGHT = nil # Stub value.
23
+
24
+ LEADER_LINE_TYPE_BEZIER = nil # Stub value.
25
+ LEADER_LINE_TYPE_SINGLE_SEGMENT = nil # Stub value.
26
+ LEADER_LINE_TYPE_TWO_SEGMENT = nil # Stub value.
27
+ LEADER_LINE_TYPE_UNKNOWN = nil # Stub value.
28
+
29
+ # Instance Methods
30
+
31
+ # The {#connect} method connects the {Layout::Label} to the given
32
+ # {Layout::ConnectionPoint}. The leader line will be adjusted to point at the
33
+ # {Layout::ConnectionPoint}. The {Layout::Label} must be in the same
34
+ # {Layout::Document} as the {Layout::ConnectionPoint}. If both the
35
+ # {Layout::Label} and the {Layout::ConnectionPoint}'s {Layout::Entity} are on
36
+ # non-shared {Layout::Layer}s, they must be on the same {Layout::Page}.
37
+ #
38
+ # @example
39
+ # text = "A label"
40
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
41
+ # target_point = Geom::Point2d.new(1, 1)
42
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
43
+ # label = Layout::Label.new(text, leader_type, target_point, bounds)
44
+ # rect = Layout::Rectangle.new([4, 4, 4, 4])
45
+ #
46
+ # doc = Layout::Document.new
47
+ # doc.add_entity(label, doc.layers.first, doc.pages.first)
48
+ # doc.add_entity(rect, doc.layers.first, doc.pages.first)
49
+ #
50
+ # point = Geom::Point2d.new(4, 4)
51
+ # # Create a Connection Point to a LayOut Entity in the Document
52
+ # cp = Layout::ConnectionPoint.new(rect, point)
53
+ # label.connect(cp)
54
+ #
55
+ # @param [Layout::ConnectionPoint] connection_point
56
+ #
57
+ # @raise [LockedLayerError] if the {Layout::Label} is on a locked
58
+ # {Layout::Layer}
59
+ #
60
+ # @raise [LockedEntityError] if the {Layout::Label} is locked
61
+ #
62
+ # @raise [ArgumentError] if the {Layout::Label} is not in the same
63
+ # {Layout::Document} as the {Layout::ConnectionPoint}
64
+ #
65
+ # @raise [ArgumentError] if both the {Layout::Label} and the
66
+ # {Layout::ConnectionPoint} are on non-shared {Layout::Layers}, but are not
67
+ # on the same {Layout::Page}.
68
+ #
69
+ # @version LayOut 2018
70
+ def connect(connection_point)
71
+ end
72
+
73
+ # The {#connection_type} method returns the type of the text connection for the
74
+ # {Layout::Label}.
75
+ #
76
+ # The leader line type can be one of the following values:
77
+ # [+Layout::Label::CONNECTION_TYPE_NONE+]
78
+ # [+Layout::Label::CONNECTION_TYPE_AUTO+]
79
+ # [+Layout::Label::CONNECTION_TYPE_REVERSE_AUTO+]
80
+ # [+Layout::Label::CONNECTION_TYPE_TOP_LEFT+]
81
+ # [+Layout::Label::CONNECTION_TYPE_CENTER_LEFT+]
82
+ # [+Layout::Label::CONNECTION_TYPE_BOTTOM_LEFT+]
83
+ # [+Layout::Label::CONNECTION_TYPE_TOP_RIGHT+]
84
+ # [+Layout::Label::CONNECTION_TYPE_CENTER_RIGHT+]
85
+ # [+Layout::Label::CONNECTION_TYPE_BOTTOM_RIGHT+]
86
+ #
87
+ # @example
88
+ # text = "A label"
89
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
90
+ # target_point = Geom::Point2d.new(1, 1)
91
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
92
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
93
+ # bounds)
94
+ # text_connection_type = label_from_bounds.connection_type
95
+ #
96
+ # @return [Integer]
97
+ #
98
+ # @version LayOut 2018
99
+ def connection_type
100
+ end
101
+
102
+ # The {#connection_type=} method sets the type of the text connection for the
103
+ # {Layout::Label}.
104
+ #
105
+ # The leader line type can be one of the following values:
106
+ # [+Layout::Label::CONNECTION_TYPE_NONE+]
107
+ # [+Layout::Label::CONNECTION_TYPE_AUTO+]
108
+ # [+Layout::Label::CONNECTION_TYPE_REVERSE_AUTO+]
109
+ # [+Layout::Label::CONNECTION_TYPE_TOP_LEFT+]
110
+ # [+Layout::Label::CONNECTION_TYPE_CENTER_LEFT+]
111
+ # [+Layout::Label::CONNECTION_TYPE_BOTTOM_LEFT+]
112
+ # [+Layout::Label::CONNECTION_TYPE_TOP_RIGHT+]
113
+ # [+Layout::Label::CONNECTION_TYPE_CENTER_RIGHT+]
114
+ # [+Layout::Label::CONNECTION_TYPE_BOTTOM_RIGHT+]
115
+ #
116
+ # @example
117
+ # text = "A label"
118
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
119
+ # target_point = Geom::Point2d.new(1, 1)
120
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
121
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
122
+ # bounds)
123
+ # label_from_bounds.connection_type = Layout::Label::CONNECTION_TYPE_TOP_LEFT
124
+ #
125
+ # @param [Integer] connection_type
126
+ #
127
+ # @raise [LockedLayerError] if the {Layout::Label} is on a locked
128
+ # {Layout::Layer}
129
+ #
130
+ # @raise [LockedEntityError] if the {Layout::Label} is locked
131
+ #
132
+ # @raise [ArgumentError] if the connection_type is not a valid text connection
133
+ # type
134
+ #
135
+ # @version LayOut 2018
136
+ def connection_type=(connection_type)
137
+ end
138
+
139
+ # The {#disconnect} method disconnects the {Layout::Label} from its
140
+ # {Layout::ConnectionPoint}. The leader line will not be adjusted by
141
+ # disconnecting from a {Layout::ConnectionPoint}.
142
+ #
143
+ # @example
144
+ # doc = Layout::Document.open("C:/path/to/document.layout")
145
+ # label = doc.pages.first.entities.first
146
+ # label.disconnect
147
+ #
148
+ # @raise [LockedLayerError] if the {Layout::Label} is on a locked
149
+ # {Layout::Layer}
150
+ #
151
+ # @raise [LockedEntityError] if the {Layout::Label} is locked
152
+ #
153
+ # @version LayOut 2018
154
+ def disconnect
155
+ end
156
+
157
+ # The {#entities} method returns the {Layout::Entities} that represent the
158
+ # {Layout::Label} in its exploded form.
159
+ #
160
+ # @example
161
+ # text = "A label"
162
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
163
+ # target_point = Geom::Point2d.new(1, 1)
164
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
165
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
166
+ # bounds)
167
+ # entities = label_from_bounds.entities
168
+ #
169
+ # @overload entities
170
+ #
171
+ # @return [Layout::Entities]
172
+ #
173
+ # @overload entities(page)
174
+ #
175
+ # @param [Layout::Page] page The {Layout::Page} to use to convert an
176
+ # auto-text tag to display text
177
+ # @return [Layout::Entities]
178
+ #
179
+ # @raise [ArgumentError] if page does not belong to the same document as the
180
+ # [Layout::Label]
181
+ #
182
+ # @version LayOut 2018
183
+ def entities(*args)
184
+ end
185
+
186
+ # The {#initialize} method creates a new disconnected {Layout::Label}.
187
+ #
188
+ # @example
189
+ # text = "A label"
190
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
191
+ # target_point = Geom::Point2d.new(1, 1)
192
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
193
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
194
+ # bounds)
195
+ # anchor_point = Geom::Point2d.new(2, 2)
196
+ # anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_RIGHT
197
+ # label_from_point = Layout::Label.new(text, leader_type, target_point,
198
+ # anchor_point, anchor_type)
199
+ #
200
+ # @overload initialize(text, leader_type, target_point, bounds)
201
+ #
202
+ # @param [String] text The label text
203
+ # @param [Integer] leader_type The leader line type
204
+ # @param [Geom::Point2d] target_point Where the label leader should point to
205
+ # @param [Geom::Bounds2d] bounds
206
+ # @return [Layout::Label]
207
+ #
208
+ # @overload initialize(text, leader_type, target_point, anchor_point, anchor_type)
209
+ #
210
+ # @param [String] text The label text
211
+ # @param [Integer] leader_type The leader line type
212
+ # @param [Geom::Point2d] target_point Where the label leader should point to
213
+ # @param [Geom::Point2d] anchor_point The anchor point for the label text's
214
+ # position.
215
+ # @param [Integer] anchor_type Defines which point of the label text is set
216
+ # by anchor_point.
217
+ # @return [Layout::Label]
218
+ #
219
+ # @raise [ArgumentError] if anchor_type is not a valid anchor type
220
+ #
221
+ # @raise [ArgumentError] if leader_type is not a valid leader line type
222
+ #
223
+ # @raise [ArgumentError] if bounds is zero size
224
+ #
225
+ # @raise [ArgumentError] if plain_text is an empty string
226
+ #
227
+ # @version LayOut 2018
228
+ def initialize(*args)
229
+ end
230
+
231
+ # The {#leader_line} method returns a copy of the leader line.
232
+ #
233
+ # @example
234
+ # text = "A label"
235
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
236
+ # target_point = Geom::Point2d.new(1, 1)
237
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
238
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
239
+ # bounds)
240
+ # leader = label_from_bounds.leader_line
241
+ #
242
+ # @return [Layout::Path]
243
+ #
244
+ # @version LayOut 2018
245
+ def leader_line
246
+ end
247
+
248
+ # The {#leader_line=} method sets the leader line.
249
+ #
250
+ # @example
251
+ # text = "A label"
252
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
253
+ # target_point = Geom::Point2d.new(1, 1)
254
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
255
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
256
+ # bounds)
257
+ # path = Layout::Path.new(Geom::Point2d.new(1, 2), Geom::Point2d.new(2, 3))
258
+ # label_from_bounds.leader_line = path
259
+ #
260
+ # @param [Layout::Path] leader_path
261
+ #
262
+ # @raise [LockedLayerError] if the {Layout::Label} is on a locked
263
+ # {Layout::Layer}
264
+ #
265
+ # @raise [LockedEntityError] if the {Layout::Label} is locked
266
+ #
267
+ # @version LayOut 2018
268
+ def leader_line=(leader_path)
269
+ end
270
+
271
+ # The {#leader_line_type} method returns the type of the leader line for the
272
+ # {Layout::Label}.
273
+ #
274
+ # The leader line type can be one of the following values:
275
+ # [+Layout::Label::LEADER_LINE_TYPE_SINGLE_SEGMENT+]
276
+ # [+Layout::Label::LEADER_LINE_TYPE_TWO_SEGMENT+]
277
+ # [+Layout::Label::LEADER_LINE_TYPE_BEZIER+]
278
+ # [+Layout::Label::LEADER_LINE_TYPE_UNKNOWN+]
279
+ #
280
+ # @example
281
+ # text = "A label"
282
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
283
+ # target_point = Geom::Point2d.new(1, 1)
284
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
285
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
286
+ # bounds)
287
+ # leader_type = label_from_bounds.leader_line_type
288
+ #
289
+ # @return [Integer]
290
+ #
291
+ # @version LayOut 2018
292
+ def leader_line_type
293
+ end
294
+
295
+ # The {#leader_line_type=} method sets the type of the leader line for the
296
+ # {Layout::Label}.
297
+ #
298
+ # The leader line type can be one of the following values:
299
+ # [+Layout::Label::LEADER_LINE_TYPE_SINGLE_SEGMENT+]
300
+ # [+Layout::Label::LEADER_LINE_TYPE_TWO_SEGMENT+]
301
+ # [+Layout::Label::LEADER_LINE_TYPE_BEZIER+]
302
+ # [+Layout::Label::LEADER_LINE_TYPE_UNKNOWN+]
303
+ #
304
+ # @example
305
+ # text = "A label"
306
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
307
+ # target_point = Geom::Point2d.new(1, 1)
308
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
309
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
310
+ # bounds)
311
+ # label_from_bounds.leader_line_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
312
+ #
313
+ # @param [Integer] leader_type
314
+ #
315
+ # @raise [LockedLayerError] if the {Layout::Label} is on a locked
316
+ # {Layout::Layer}
317
+ #
318
+ # @raise [LockedEntityError] if the {Layout::Label} is locked
319
+ #
320
+ # @raise [ArgumentError] if leader_type is
321
+ # +Layout::Label::LEADER_LINE_TYPE_UNKNOWN+ or not a valid leader line type
322
+ #
323
+ # @version LayOut 2018
324
+ def leader_line_type=(leader_type)
325
+ end
326
+
327
+ # The {#text} method returns a copy of the {Layout::FormattedText} of the
328
+ # {Layout::Label}.
329
+ #
330
+ # @example
331
+ # text = "A label"
332
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
333
+ # target_point = Geom::Point2d.new(1, 1)
334
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
335
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
336
+ # bounds)
337
+ # text = label_from_bounds.text
338
+ #
339
+ # @return [Layout::FormattedText]
340
+ #
341
+ # @version LayOut 2018
342
+ def text
343
+ end
344
+
345
+ # The {#text=} method sets the {Layout::FormattedText} of the {Layout::Label}.
346
+ #
347
+ # @example
348
+ # text = "A label"
349
+ # leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
350
+ # target_point = Geom::Point2d.new(1, 1)
351
+ # bounds = Geom::Bounds2d.new(2, 1, 1, 1)
352
+ # label_from_bounds = Layout::Label.new(text, leader_type, target_point,
353
+ # bounds)
354
+ # anchor = Geom::Point2d.new(1, 1)
355
+ # anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT
356
+ # text = Layout::FormattedText.new("Test", anchor, anchor_type)
357
+ # label_from_bounds.text = text
358
+ #
359
+ # @param [Layout::FormattedText] new_text
360
+ #
361
+ # @raise [LockedLayerError] if the {Layout::Label} is on a locked
362
+ # {Layout::Layer}
363
+ #
364
+ # @raise [LockedEntityError] if the {Layout::Label} is locked
365
+ #
366
+ # @version LayOut 2018
367
+ def text=(new_text)
368
+ end
369
+
370
+ end