@mlightcad/data-model 1.1.2 → 1.1.3

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 (259) hide show
  1. package/dist/data-model.js +5490 -1022
  2. package/dist/data-model.umd.cjs +2 -2
  3. package/lib/base/AcDbHostApplicationServices.d.ts +72 -6
  4. package/lib/base/AcDbHostApplicationServices.d.ts.map +1 -1
  5. package/lib/base/AcDbHostApplicationServices.js +71 -7
  6. package/lib/base/AcDbHostApplicationServices.js.map +1 -1
  7. package/lib/base/AcDbObject.d.ts +160 -25
  8. package/lib/base/AcDbObject.d.ts.map +1 -1
  9. package/lib/base/AcDbObject.js +149 -25
  10. package/lib/base/AcDbObject.js.map +1 -1
  11. package/lib/converter/AcDbBatchProcessing.d.ts +112 -10
  12. package/lib/converter/AcDbBatchProcessing.d.ts.map +1 -1
  13. package/lib/converter/AcDbBatchProcessing.js +110 -11
  14. package/lib/converter/AcDbBatchProcessing.js.map +1 -1
  15. package/lib/converter/AcDbDxfConverter.d.ts +224 -6
  16. package/lib/converter/AcDbDxfConverter.d.ts.map +1 -1
  17. package/lib/converter/AcDbDxfConverter.js +224 -6
  18. package/lib/converter/AcDbDxfConverter.js.map +1 -1
  19. package/lib/converter/AcDbDxfParseWorker.d.ts +16 -0
  20. package/lib/converter/AcDbDxfParseWorker.d.ts.map +1 -1
  21. package/lib/converter/AcDbDxfParseWorker.js +16 -0
  22. package/lib/converter/AcDbDxfParseWorker.js.map +1 -1
  23. package/lib/converter/AcDbEntitiyConverter.d.ts +118 -3
  24. package/lib/converter/AcDbEntitiyConverter.d.ts.map +1 -1
  25. package/lib/converter/AcDbEntitiyConverter.js +118 -3
  26. package/lib/converter/AcDbEntitiyConverter.js.map +1 -1
  27. package/lib/converter/AcDbObjectConverter.d.ts +52 -0
  28. package/lib/converter/AcDbObjectConverter.d.ts.map +1 -1
  29. package/lib/converter/AcDbObjectConverter.js +52 -0
  30. package/lib/converter/AcDbObjectConverter.js.map +1 -1
  31. package/lib/database/AcDbBlockTable.d.ts +35 -3
  32. package/lib/database/AcDbBlockTable.d.ts.map +1 -1
  33. package/lib/database/AcDbBlockTable.js +35 -3
  34. package/lib/database/AcDbBlockTable.js.map +1 -1
  35. package/lib/database/AcDbBlockTableRecord.d.ts +98 -15
  36. package/lib/database/AcDbBlockTableRecord.d.ts.map +1 -1
  37. package/lib/database/AcDbBlockTableRecord.js +96 -15
  38. package/lib/database/AcDbBlockTableRecord.js.map +1 -1
  39. package/lib/database/AcDbDatabase.d.ts +303 -33
  40. package/lib/database/AcDbDatabase.d.ts.map +1 -1
  41. package/lib/database/AcDbDatabase.js +223 -39
  42. package/lib/database/AcDbDatabase.js.map +1 -1
  43. package/lib/database/AcDbDatabaseConverter.d.ts +77 -12
  44. package/lib/database/AcDbDatabaseConverter.d.ts.map +1 -1
  45. package/lib/database/AcDbDatabaseConverter.js +46 -13
  46. package/lib/database/AcDbDatabaseConverter.js.map +1 -1
  47. package/lib/database/AcDbDatabaseConverterManager.d.ts +97 -15
  48. package/lib/database/AcDbDatabaseConverterManager.d.ts.map +1 -1
  49. package/lib/database/AcDbDatabaseConverterManager.js +90 -15
  50. package/lib/database/AcDbDatabaseConverterManager.js.map +1 -1
  51. package/lib/database/AcDbDimStyleTable.d.ts +22 -2
  52. package/lib/database/AcDbDimStyleTable.d.ts.map +1 -1
  53. package/lib/database/AcDbDimStyleTable.js +22 -2
  54. package/lib/database/AcDbDimStyleTable.js.map +1 -1
  55. package/lib/database/AcDbDimStyleTableRecord.d.ts +115 -0
  56. package/lib/database/AcDbDimStyleTableRecord.d.ts.map +1 -1
  57. package/lib/database/AcDbDimStyleTableRecord.js +44 -0
  58. package/lib/database/AcDbDimStyleTableRecord.js.map +1 -1
  59. package/lib/database/AcDbLayerTable.d.ts +39 -2
  60. package/lib/database/AcDbLayerTable.d.ts.map +1 -1
  61. package/lib/database/AcDbLayerTable.js +39 -2
  62. package/lib/database/AcDbLayerTable.js.map +1 -1
  63. package/lib/database/AcDbLayerTableRecord.d.ts +198 -18
  64. package/lib/database/AcDbLayerTableRecord.d.ts.map +1 -1
  65. package/lib/database/AcDbLayerTableRecord.js +182 -19
  66. package/lib/database/AcDbLayerTableRecord.js.map +1 -1
  67. package/lib/database/AcDbLinetypeTable.d.ts +21 -2
  68. package/lib/database/AcDbLinetypeTable.d.ts.map +1 -1
  69. package/lib/database/AcDbLinetypeTable.js +21 -2
  70. package/lib/database/AcDbLinetypeTable.js.map +1 -1
  71. package/lib/database/AcDbLinetypeTableRecord.d.ts +46 -14
  72. package/lib/database/AcDbLinetypeTableRecord.d.ts.map +1 -1
  73. package/lib/database/AcDbLinetypeTableRecord.js +46 -14
  74. package/lib/database/AcDbLinetypeTableRecord.js.map +1 -1
  75. package/lib/database/AcDbSymbolTable.d.ts +134 -29
  76. package/lib/database/AcDbSymbolTable.d.ts.map +1 -1
  77. package/lib/database/AcDbSymbolTable.js +133 -37
  78. package/lib/database/AcDbSymbolTable.js.map +1 -1
  79. package/lib/database/AcDbSymbolTableRecord.d.ts +47 -2
  80. package/lib/database/AcDbSymbolTableRecord.d.ts.map +1 -1
  81. package/lib/database/AcDbSymbolTableRecord.js +40 -2
  82. package/lib/database/AcDbSymbolTableRecord.js.map +1 -1
  83. package/lib/database/AcDbTextStyleTable.d.ts +36 -2
  84. package/lib/database/AcDbTextStyleTable.d.ts.map +1 -1
  85. package/lib/database/AcDbTextStyleTable.js +36 -2
  86. package/lib/database/AcDbTextStyleTable.js.map +1 -1
  87. package/lib/database/AcDbTextStyleTableRecord.d.ts +129 -17
  88. package/lib/database/AcDbTextStyleTableRecord.d.ts.map +1 -1
  89. package/lib/database/AcDbTextStyleTableRecord.js +127 -17
  90. package/lib/database/AcDbTextStyleTableRecord.js.map +1 -1
  91. package/lib/database/AcDbViewportTable.d.ts +22 -2
  92. package/lib/database/AcDbViewportTable.d.ts.map +1 -1
  93. package/lib/database/AcDbViewportTable.js +22 -2
  94. package/lib/database/AcDbViewportTable.js.map +1 -1
  95. package/lib/database/AcDbViewportTableRecord.d.ts +74 -9
  96. package/lib/database/AcDbViewportTableRecord.d.ts.map +1 -1
  97. package/lib/database/AcDbViewportTableRecord.js +65 -9
  98. package/lib/database/AcDbViewportTableRecord.js.map +1 -1
  99. package/lib/entity/AcDbArc.d.ts +202 -17
  100. package/lib/entity/AcDbArc.d.ts.map +1 -1
  101. package/lib/entity/AcDbArc.js +201 -17
  102. package/lib/entity/AcDbArc.js.map +1 -1
  103. package/lib/entity/AcDbBlockReference.d.ts +147 -13
  104. package/lib/entity/AcDbBlockReference.d.ts.map +1 -1
  105. package/lib/entity/AcDbBlockReference.js +142 -13
  106. package/lib/entity/AcDbBlockReference.js.map +1 -1
  107. package/lib/entity/AcDbCircle.d.ts +145 -12
  108. package/lib/entity/AcDbCircle.d.ts.map +1 -1
  109. package/lib/entity/AcDbCircle.js +144 -12
  110. package/lib/entity/AcDbCircle.js.map +1 -1
  111. package/lib/entity/AcDbCurve.d.ts +33 -2
  112. package/lib/entity/AcDbCurve.d.ts.map +1 -1
  113. package/lib/entity/AcDbCurve.js +17 -0
  114. package/lib/entity/AcDbCurve.js.map +1 -1
  115. package/lib/entity/AcDbEllipse.d.ts +168 -16
  116. package/lib/entity/AcDbEllipse.d.ts.map +1 -1
  117. package/lib/entity/AcDbEllipse.js +167 -16
  118. package/lib/entity/AcDbEllipse.js.map +1 -1
  119. package/lib/entity/AcDbEntity.d.ts +299 -35
  120. package/lib/entity/AcDbEntity.d.ts.map +1 -1
  121. package/lib/entity/AcDbEntity.js +275 -27
  122. package/lib/entity/AcDbEntity.js.map +1 -1
  123. package/lib/entity/AcDbHatch.d.ts +60 -4
  124. package/lib/entity/AcDbHatch.d.ts.map +1 -1
  125. package/lib/entity/AcDbHatch.js +52 -4
  126. package/lib/entity/AcDbHatch.js.map +1 -1
  127. package/lib/entity/AcDbLeader.d.ts +157 -10
  128. package/lib/entity/AcDbLeader.d.ts.map +1 -1
  129. package/lib/entity/AcDbLeader.js +149 -10
  130. package/lib/entity/AcDbLeader.js.map +1 -1
  131. package/lib/entity/AcDbLine.d.ts +154 -13
  132. package/lib/entity/AcDbLine.d.ts.map +1 -1
  133. package/lib/entity/AcDbLine.js +153 -13
  134. package/lib/entity/AcDbLine.js.map +1 -1
  135. package/lib/entity/AcDbMText.d.ts +127 -11
  136. package/lib/entity/AcDbMText.d.ts.map +1 -1
  137. package/lib/entity/AcDbMText.js +112 -11
  138. package/lib/entity/AcDbMText.js.map +1 -1
  139. package/lib/entity/AcDbPoint.d.ts +86 -7
  140. package/lib/entity/AcDbPoint.d.ts.map +1 -1
  141. package/lib/entity/AcDbPoint.js +85 -7
  142. package/lib/entity/AcDbPoint.js.map +1 -1
  143. package/lib/entity/AcDbPolyline.d.ts +172 -25
  144. package/lib/entity/AcDbPolyline.d.ts.map +1 -1
  145. package/lib/entity/AcDbPolyline.js +170 -25
  146. package/lib/entity/AcDbPolyline.js.map +1 -1
  147. package/lib/entity/AcDbRasterImage.d.ts +75 -31
  148. package/lib/entity/AcDbRasterImage.d.ts.map +1 -1
  149. package/lib/entity/AcDbRasterImage.js +60 -31
  150. package/lib/entity/AcDbRasterImage.js.map +1 -1
  151. package/lib/entity/AcDbRay.d.ts +115 -9
  152. package/lib/entity/AcDbRay.d.ts.map +1 -1
  153. package/lib/entity/AcDbRay.js +113 -9
  154. package/lib/entity/AcDbRay.js.map +1 -1
  155. package/lib/entity/AcDbSpline.d.ts +106 -14
  156. package/lib/entity/AcDbSpline.d.ts.map +1 -1
  157. package/lib/entity/AcDbSpline.js +67 -4
  158. package/lib/entity/AcDbSpline.js.map +1 -1
  159. package/lib/entity/AcDbTable.d.ts +161 -44
  160. package/lib/entity/AcDbTable.d.ts.map +1 -1
  161. package/lib/entity/AcDbTable.js +135 -44
  162. package/lib/entity/AcDbTable.js.map +1 -1
  163. package/lib/entity/AcDbText.d.ts +298 -25
  164. package/lib/entity/AcDbText.d.ts.map +1 -1
  165. package/lib/entity/AcDbText.js +288 -25
  166. package/lib/entity/AcDbText.js.map +1 -1
  167. package/lib/entity/AcDbTrace.d.ts +150 -23
  168. package/lib/entity/AcDbTrace.d.ts.map +1 -1
  169. package/lib/entity/AcDbTrace.js +147 -23
  170. package/lib/entity/AcDbTrace.js.map +1 -1
  171. package/lib/entity/AcDbViewport.d.ts +122 -9
  172. package/lib/entity/AcDbViewport.d.ts.map +1 -1
  173. package/lib/entity/AcDbViewport.js +122 -9
  174. package/lib/entity/AcDbViewport.js.map +1 -1
  175. package/lib/entity/AcDbWipeout.d.ts +29 -1
  176. package/lib/entity/AcDbWipeout.d.ts.map +1 -1
  177. package/lib/entity/AcDbWipeout.js +29 -1
  178. package/lib/entity/AcDbWipeout.js.map +1 -1
  179. package/lib/entity/AcDbXline.d.ts +116 -9
  180. package/lib/entity/AcDbXline.d.ts.map +1 -1
  181. package/lib/entity/AcDbXline.js +114 -9
  182. package/lib/entity/AcDbXline.js.map +1 -1
  183. package/lib/entity/dimension/AcDb3PointAngularDimension.d.ts +56 -12
  184. package/lib/entity/dimension/AcDb3PointAngularDimension.d.ts.map +1 -1
  185. package/lib/entity/dimension/AcDb3PointAngularDimension.js +56 -12
  186. package/lib/entity/dimension/AcDb3PointAngularDimension.js.map +1 -1
  187. package/lib/entity/dimension/AcDbAlignedDimension.d.ts +158 -17
  188. package/lib/entity/dimension/AcDbAlignedDimension.d.ts.map +1 -1
  189. package/lib/entity/dimension/AcDbAlignedDimension.js +153 -17
  190. package/lib/entity/dimension/AcDbAlignedDimension.js.map +1 -1
  191. package/lib/entity/dimension/AcDbArcDimension.d.ts +58 -12
  192. package/lib/entity/dimension/AcDbArcDimension.d.ts.map +1 -1
  193. package/lib/entity/dimension/AcDbArcDimension.js +58 -12
  194. package/lib/entity/dimension/AcDbArcDimension.js.map +1 -1
  195. package/lib/entity/dimension/AcDbDiametricDimension.d.ts +99 -25
  196. package/lib/entity/dimension/AcDbDiametricDimension.d.ts.map +1 -1
  197. package/lib/entity/dimension/AcDbDiametricDimension.js +99 -25
  198. package/lib/entity/dimension/AcDbDiametricDimension.js.map +1 -1
  199. package/lib/entity/dimension/AcDbDimension.d.ts +108 -14
  200. package/lib/entity/dimension/AcDbDimension.d.ts.map +1 -1
  201. package/lib/entity/dimension/AcDbDimension.js +99 -14
  202. package/lib/entity/dimension/AcDbDimension.js.map +1 -1
  203. package/lib/entity/dimension/AcDbOrdinateDimension.d.ts +48 -16
  204. package/lib/entity/dimension/AcDbOrdinateDimension.d.ts.map +1 -1
  205. package/lib/entity/dimension/AcDbOrdinateDimension.js +48 -16
  206. package/lib/entity/dimension/AcDbOrdinateDimension.js.map +1 -1
  207. package/lib/entity/dimension/AcDbRadialDimension.d.ts +167 -24
  208. package/lib/entity/dimension/AcDbRadialDimension.d.ts.map +1 -1
  209. package/lib/entity/dimension/AcDbRadialDimension.js +162 -24
  210. package/lib/entity/dimension/AcDbRadialDimension.js.map +1 -1
  211. package/lib/misc/AcDbAngleUnits.d.ts +12 -0
  212. package/lib/misc/AcDbAngleUnits.d.ts.map +1 -1
  213. package/lib/misc/AcDbAngleUnits.js +12 -0
  214. package/lib/misc/AcDbAngleUnits.js.map +1 -1
  215. package/lib/misc/AcDbConstants.d.ts +20 -0
  216. package/lib/misc/AcDbConstants.d.ts.map +1 -1
  217. package/lib/misc/AcDbConstants.js +20 -0
  218. package/lib/misc/AcDbConstants.js.map +1 -1
  219. package/lib/misc/AcDbDimArrowType.d.ts +24 -21
  220. package/lib/misc/AcDbDimArrowType.d.ts.map +1 -1
  221. package/lib/misc/AcDbDimArrowType.js +24 -21
  222. package/lib/misc/AcDbDimArrowType.js.map +1 -1
  223. package/lib/misc/AcDbObjectIterator.d.ts +42 -3
  224. package/lib/misc/AcDbObjectIterator.d.ts.map +1 -1
  225. package/lib/misc/AcDbObjectIterator.js +42 -3
  226. package/lib/misc/AcDbObjectIterator.js.map +1 -1
  227. package/lib/misc/AcDbOsnapMode.d.ts +18 -10
  228. package/lib/misc/AcDbOsnapMode.d.ts.map +1 -1
  229. package/lib/misc/AcDbOsnapMode.js +18 -10
  230. package/lib/misc/AcDbOsnapMode.js.map +1 -1
  231. package/lib/misc/AcDbRenderingCache.d.ts +107 -29
  232. package/lib/misc/AcDbRenderingCache.d.ts.map +1 -1
  233. package/lib/misc/AcDbRenderingCache.js +105 -29
  234. package/lib/misc/AcDbRenderingCache.js.map +1 -1
  235. package/lib/misc/AcDbUnitsValue.d.ts +58 -8
  236. package/lib/misc/AcDbUnitsValue.d.ts.map +1 -1
  237. package/lib/misc/AcDbUnitsValue.js +58 -8
  238. package/lib/misc/AcDbUnitsValue.js.map +1 -1
  239. package/lib/object/AcDbDictionary.d.ts +128 -30
  240. package/lib/object/AcDbDictionary.d.ts.map +1 -1
  241. package/lib/object/AcDbDictionary.js +126 -30
  242. package/lib/object/AcDbDictionary.js.map +1 -1
  243. package/lib/object/AcDbRasterImageDef.d.ts +38 -9
  244. package/lib/object/AcDbRasterImageDef.d.ts.map +1 -1
  245. package/lib/object/AcDbRasterImageDef.js +37 -9
  246. package/lib/object/AcDbRasterImageDef.js.map +1 -1
  247. package/lib/object/layout/AcDbLayout.d.ts +152 -13
  248. package/lib/object/layout/AcDbLayout.d.ts.map +1 -1
  249. package/lib/object/layout/AcDbLayout.js +146 -13
  250. package/lib/object/layout/AcDbLayout.js.map +1 -1
  251. package/lib/object/layout/AcDbLayoutDictionary.d.ts +35 -7
  252. package/lib/object/layout/AcDbLayoutDictionary.d.ts.map +1 -1
  253. package/lib/object/layout/AcDbLayoutDictionary.js +35 -7
  254. package/lib/object/layout/AcDbLayoutDictionary.js.map +1 -1
  255. package/lib/object/layout/AcDbLayoutManager.d.ts +103 -31
  256. package/lib/object/layout/AcDbLayoutManager.d.ts.map +1 -1
  257. package/lib/object/layout/AcDbLayoutManager.js +98 -31
  258. package/lib/object/layout/AcDbLayoutManager.js.map +1 -1
  259. package/package.json +4 -4
@@ -1,67 +1,179 @@
1
1
  import { AcGiBaseTextStyle } from '@mlightcad/graphic-interface';
2
2
  import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
3
3
  /**
4
+ * Represents a record in the text style table.
5
+ *
4
6
  * This class represents the records that are found in the text style table (known as the "style"
5
7
  * table in DXF). Each of these records represents a specific set of text parameters such as font,
6
- * default size, relative x scaling, vertical or horizontal, etc.
8
+ * default size, relative x scaling, vertical or horizontal orientation, etc.
9
+ *
10
+ * @example
11
+ * ```typescript
12
+ * const textStyle = new AcGiBaseTextStyle();
13
+ * textStyle.name = 'MyStyle';
14
+ * textStyle.font = 'Arial';
15
+ * const record = new AcDbTextStyleTableRecord(textStyle);
16
+ * ```
7
17
  */
8
18
  export declare class AcDbTextStyleTableRecord extends AcDbSymbolTableRecord {
19
+ /** The text style configuration */
9
20
  private _textStyle;
21
+ /** Whether text drawn with this style is vertical */
10
22
  private _isVertical;
23
+ /**
24
+ * Creates a new AcDbTextStyleTableRecord instance.
25
+ *
26
+ * @param textStyle - The text style configuration to use
27
+ *
28
+ * @example
29
+ * ```typescript
30
+ * const textStyle = new AcGiBaseTextStyle();
31
+ * textStyle.name = 'MyStyle';
32
+ * const record = new AcDbTextStyleTableRecord(textStyle);
33
+ * ```
34
+ */
11
35
  constructor(textStyle: AcGiBaseTextStyle);
12
36
  /**
13
- * The obliquing angle. The obliquing angle is the angle from the text's vertical; that is, the
37
+ * Gets or sets the obliquing angle.
38
+ *
39
+ * The obliquing angle is the angle from the text's vertical; that is, the
14
40
  * top of the text "slants" relative to the bottom--the same as the slope in this italic text.
15
41
  * Positive angles slant characters forward at their tops. Negative angles have 2pi added to them
16
42
  * to convert them to their positive equivalent.
43
+ *
44
+ * @returns The obliquing angle in radians
45
+ *
46
+ * @example
47
+ * ```typescript
48
+ * const angle = record.obliquingAngle;
49
+ * record.obliquingAngle = Math.PI / 6; // 30 degrees
50
+ * ```
17
51
  */
18
52
  get obliquingAngle(): number;
19
53
  set obliquingAngle(value: number);
20
54
  /**
21
- * The text height used for the last text created using this text style. This value is updated
22
- * automatically by AutoCAD after the creation of any text object that references this text style
23
- * table record. If the textSize value for this text style is 0, then the priorSize value is used
24
- * by AutoCAD as the default text height for the next text created using this text style.
55
+ * Gets or sets the text height used for the last text created using this text style.
56
+ *
57
+ * This value is updated automatically by AutoCAD after the creation of any text object
58
+ * that references this text style table record. If the textSize value for this text style
59
+ * is 0, then the priorSize value is used by AutoCAD as the default text height for the
60
+ * next text created using this text style.
25
61
  *
26
- * This value is automatically changed by the use of the text command. It will only be automatically
27
- * changed if the textSize is set to 0 so that users are prompted for a height.
62
+ * This value is automatically changed by the use of the text command. It will only be
63
+ * automatically changed if the textSize is set to 0 so that users are prompted for a height.
64
+ *
65
+ * @returns The prior text size
66
+ *
67
+ * @example
68
+ * ```typescript
69
+ * const priorSize = record.priorSize;
70
+ * record.priorSize = 12.0;
71
+ * ```
28
72
  */
29
73
  get priorSize(): number;
30
74
  set priorSize(value: number);
31
75
  /**
32
- * The default size of the text drawn with this text style. If the text size is set to 0, then each
33
- * use of the AutoCAD text commands prompt for a text height to use in creating the text entity. If
34
- * textSize is non-zero, the text command will not prompt for a text height and will use this value.
76
+ * Gets or sets the default size of the text drawn with this text style.
77
+ *
78
+ * If the text size is set to 0, then each use of the AutoCAD text commands prompt
79
+ * for a text height to use in creating the text entity. If textSize is non-zero,
80
+ * the text command will not prompt for a text height and will use this value.
81
+ *
82
+ * @returns The default text size
83
+ *
84
+ * @example
85
+ * ```typescript
86
+ * const textSize = record.textSize;
87
+ * record.textSize = 10.0; // Fixed text height
88
+ * ```
35
89
  */
36
90
  get textSize(): number;
37
91
  set textSize(value: number);
38
92
  /**
39
- * The width factor (also referred to as the relative X-scale factor) for the text style table
40
- * record. The width factor is applied to the text's width to allow the width to be adjusted
93
+ * Gets or sets the width factor (also referred to as the relative X-scale factor) for the text style.
94
+ *
95
+ * The width factor is applied to the text's width to allow the width to be adjusted
41
96
  * independently of the height. For example, if the width factor value is 0.8, then the text is
42
97
  * drawn with a width that is 80% of its normal "unadjusted" width.
98
+ *
99
+ * @returns The width factor
100
+ *
101
+ * @example
102
+ * ```typescript
103
+ * const xScale = record.xScale;
104
+ * record.xScale = 0.8; // 80% width
105
+ * ```
43
106
  */
44
107
  get xScale(): number;
45
108
  set xScale(value: number);
46
109
  /**
47
- * True if text drawn with this text style is drawn vertically. Faslse otherwise.
110
+ * Gets or sets whether text drawn with this text style is drawn vertically.
111
+ *
112
+ * @returns True if text is drawn vertically, false otherwise
113
+ *
114
+ * @example
115
+ * ```typescript
116
+ * if (record.isVertical) {
117
+ * console.log('Text style is vertical');
118
+ * }
119
+ * record.isVertical = true;
120
+ * ```
48
121
  */
49
122
  get isVertical(): boolean;
50
123
  set isVertical(value: boolean);
51
124
  /**
52
- * The name of the font file for this text style
125
+ * Gets or sets the name of the font file for this text style.
126
+ *
127
+ * @returns The font file name
128
+ *
129
+ * @example
130
+ * ```typescript
131
+ * const fileName = record.fileName;
132
+ * record.fileName = 'Arial';
133
+ * ```
53
134
  */
54
135
  get fileName(): string;
55
136
  set fileName(value: string);
56
137
  /**
57
- * The name of the big font file for this text style
138
+ * Gets or sets the name of the big font file for this text style.
139
+ *
140
+ * Big font files are used for languages that require more than 256 characters,
141
+ * such as Chinese, Japanese, and Korean.
142
+ *
143
+ * @returns The big font file name
144
+ *
145
+ * @example
146
+ * ```typescript
147
+ * const bigFontFileName = record.bigFontFileName;
148
+ * record.bigFontFileName = 'bigfont.shx';
149
+ * ```
58
150
  */
59
151
  get bigFontFileName(): string;
60
152
  set bigFontFileName(value: string);
61
153
  /**
62
- * Text style information used by renderer.
154
+ * Gets the text style information used by the renderer.
155
+ *
156
+ * @returns The text style configuration
157
+ *
158
+ * @example
159
+ * ```typescript
160
+ * const textStyle = record.textStyle;
161
+ * console.log('Font:', textStyle.font);
162
+ * ```
63
163
  */
64
164
  get textStyle(): AcGiBaseTextStyle;
165
+ /**
166
+ * Removes the file extension from a file name.
167
+ *
168
+ * @param pathName - The file path or name
169
+ * @returns The file name without extension
170
+ *
171
+ * @example
172
+ * ```typescript
173
+ * const fileName = this.getFileNameWithoutExtension('arial.ttf');
174
+ * // Returns: 'arial'
175
+ * ```
176
+ */
65
177
  private getFileNameWithoutExtension;
66
178
  }
67
179
  //# sourceMappingURL=AcDbTextStyleTableRecord.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"AcDbTextStyleTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbTextStyleTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;GAIG;AACH,qBAAa,wBAAyB,SAAQ,qBAAqB;IACjE,OAAO,CAAC,UAAU,CAAmB;IACrC,OAAO,CAAC,WAAW,CAAS;gBAEhB,SAAS,EAAE,iBAAiB;IAYxC;;;;;OAKG;IACH,IAAI,cAAc,IAGQ,MAAM,CAD/B;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAE/B;IAED;;;;;;;;OAQG;IACH,IAAI,SAAS,IAGQ,MAAM,CAD1B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;OAEG;IACH,IAAI,UAAU,IAGQ,OAAO,CAD5B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,OAAO,EAE5B;IAED;;OAEG;IACH,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;OAEG;IACH,IAAI,eAAe,IAGQ,MAAM,CADhC;IACD,IAAI,eAAe,CAAC,KAAK,EAAE,MAAM,EAEhC;IAED;;OAEG;IACH,IAAI,SAAS,sBAEZ;IAED,OAAO,CAAC,2BAA2B;CAgBpC"}
1
+ {"version":3,"file":"AcDbTextStyleTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbTextStyleTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;;;;;GAcG;AACH,qBAAa,wBAAyB,SAAQ,qBAAqB;IACjE,mCAAmC;IACnC,OAAO,CAAC,UAAU,CAAmB;IACrC,qDAAqD;IACrD,OAAO,CAAC,WAAW,CAAS;IAE5B;;;;;;;;;;;OAWG;gBACS,SAAS,EAAE,iBAAiB;IAYxC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,cAAc,IAGQ,MAAM,CAD/B;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAE/B;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,SAAS,IAGQ,MAAM,CAD1B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,UAAU,IAGQ,OAAO,CAD5B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,OAAO,EAE5B;IAED;;;;;;;;;;OAUG;IACH,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,eAAe,IAGQ,MAAM,CADhC;IACD,IAAI,eAAe,CAAC,KAAK,EAAE,MAAM,EAEhC;IAED;;;;;;;;;;OAUG;IACH,IAAI,SAAS,sBAEZ;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,2BAA2B;CAgBpC"}
@@ -15,12 +15,34 @@ var __extends = (this && this.__extends) || (function () {
15
15
  })();
16
16
  import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
17
17
  /**
18
+ * Represents a record in the text style table.
19
+ *
18
20
  * This class represents the records that are found in the text style table (known as the "style"
19
21
  * table in DXF). Each of these records represents a specific set of text parameters such as font,
20
- * default size, relative x scaling, vertical or horizontal, etc.
22
+ * default size, relative x scaling, vertical or horizontal orientation, etc.
23
+ *
24
+ * @example
25
+ * ```typescript
26
+ * const textStyle = new AcGiBaseTextStyle();
27
+ * textStyle.name = 'MyStyle';
28
+ * textStyle.font = 'Arial';
29
+ * const record = new AcDbTextStyleTableRecord(textStyle);
30
+ * ```
21
31
  */
22
32
  var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
23
33
  __extends(AcDbTextStyleTableRecord, _super);
34
+ /**
35
+ * Creates a new AcDbTextStyleTableRecord instance.
36
+ *
37
+ * @param textStyle - The text style configuration to use
38
+ *
39
+ * @example
40
+ * ```typescript
41
+ * const textStyle = new AcGiBaseTextStyle();
42
+ * textStyle.name = 'MyStyle';
43
+ * const record = new AcDbTextStyleTableRecord(textStyle);
44
+ * ```
45
+ */
24
46
  function AcDbTextStyleTableRecord(textStyle) {
25
47
  var _this = _super.call(this) || this;
26
48
  _this.name = textStyle.name;
@@ -33,10 +55,20 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
33
55
  }
34
56
  Object.defineProperty(AcDbTextStyleTableRecord.prototype, "obliquingAngle", {
35
57
  /**
36
- * The obliquing angle. The obliquing angle is the angle from the text's vertical; that is, the
58
+ * Gets or sets the obliquing angle.
59
+ *
60
+ * The obliquing angle is the angle from the text's vertical; that is, the
37
61
  * top of the text "slants" relative to the bottom--the same as the slope in this italic text.
38
62
  * Positive angles slant characters forward at their tops. Negative angles have 2pi added to them
39
63
  * to convert them to their positive equivalent.
64
+ *
65
+ * @returns The obliquing angle in radians
66
+ *
67
+ * @example
68
+ * ```typescript
69
+ * const angle = record.obliquingAngle;
70
+ * record.obliquingAngle = Math.PI / 6; // 30 degrees
71
+ * ```
40
72
  */
41
73
  get: function () {
42
74
  return this._textStyle.obliqueAngle;
@@ -49,13 +81,23 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
49
81
  });
50
82
  Object.defineProperty(AcDbTextStyleTableRecord.prototype, "priorSize", {
51
83
  /**
52
- * The text height used for the last text created using this text style. This value is updated
53
- * automatically by AutoCAD after the creation of any text object that references this text style
54
- * table record. If the textSize value for this text style is 0, then the priorSize value is used
55
- * by AutoCAD as the default text height for the next text created using this text style.
84
+ * Gets or sets the text height used for the last text created using this text style.
85
+ *
86
+ * This value is updated automatically by AutoCAD after the creation of any text object
87
+ * that references this text style table record. If the textSize value for this text style
88
+ * is 0, then the priorSize value is used by AutoCAD as the default text height for the
89
+ * next text created using this text style.
90
+ *
91
+ * This value is automatically changed by the use of the text command. It will only be
92
+ * automatically changed if the textSize is set to 0 so that users are prompted for a height.
93
+ *
94
+ * @returns The prior text size
56
95
  *
57
- * This value is automatically changed by the use of the text command. It will only be automatically
58
- * changed if the textSize is set to 0 so that users are prompted for a height.
96
+ * @example
97
+ * ```typescript
98
+ * const priorSize = record.priorSize;
99
+ * record.priorSize = 12.0;
100
+ * ```
59
101
  */
60
102
  get: function () {
61
103
  return this._textStyle.lastHeight;
@@ -68,9 +110,19 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
68
110
  });
69
111
  Object.defineProperty(AcDbTextStyleTableRecord.prototype, "textSize", {
70
112
  /**
71
- * The default size of the text drawn with this text style. If the text size is set to 0, then each
72
- * use of the AutoCAD text commands prompt for a text height to use in creating the text entity. If
73
- * textSize is non-zero, the text command will not prompt for a text height and will use this value.
113
+ * Gets or sets the default size of the text drawn with this text style.
114
+ *
115
+ * If the text size is set to 0, then each use of the AutoCAD text commands prompt
116
+ * for a text height to use in creating the text entity. If textSize is non-zero,
117
+ * the text command will not prompt for a text height and will use this value.
118
+ *
119
+ * @returns The default text size
120
+ *
121
+ * @example
122
+ * ```typescript
123
+ * const textSize = record.textSize;
124
+ * record.textSize = 10.0; // Fixed text height
125
+ * ```
74
126
  */
75
127
  get: function () {
76
128
  return this._textStyle.fixedTextHeight;
@@ -83,10 +135,19 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
83
135
  });
84
136
  Object.defineProperty(AcDbTextStyleTableRecord.prototype, "xScale", {
85
137
  /**
86
- * The width factor (also referred to as the relative X-scale factor) for the text style table
87
- * record. The width factor is applied to the text's width to allow the width to be adjusted
138
+ * Gets or sets the width factor (also referred to as the relative X-scale factor) for the text style.
139
+ *
140
+ * The width factor is applied to the text's width to allow the width to be adjusted
88
141
  * independently of the height. For example, if the width factor value is 0.8, then the text is
89
142
  * drawn with a width that is 80% of its normal "unadjusted" width.
143
+ *
144
+ * @returns The width factor
145
+ *
146
+ * @example
147
+ * ```typescript
148
+ * const xScale = record.xScale;
149
+ * record.xScale = 0.8; // 80% width
150
+ * ```
90
151
  */
91
152
  get: function () {
92
153
  return this._textStyle.widthFactor;
@@ -99,7 +160,17 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
99
160
  });
100
161
  Object.defineProperty(AcDbTextStyleTableRecord.prototype, "isVertical", {
101
162
  /**
102
- * True if text drawn with this text style is drawn vertically. Faslse otherwise.
163
+ * Gets or sets whether text drawn with this text style is drawn vertically.
164
+ *
165
+ * @returns True if text is drawn vertically, false otherwise
166
+ *
167
+ * @example
168
+ * ```typescript
169
+ * if (record.isVertical) {
170
+ * console.log('Text style is vertical');
171
+ * }
172
+ * record.isVertical = true;
173
+ * ```
103
174
  */
104
175
  get: function () {
105
176
  return this._isVertical;
@@ -112,7 +183,15 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
112
183
  });
113
184
  Object.defineProperty(AcDbTextStyleTableRecord.prototype, "fileName", {
114
185
  /**
115
- * The name of the font file for this text style
186
+ * Gets or sets the name of the font file for this text style.
187
+ *
188
+ * @returns The font file name
189
+ *
190
+ * @example
191
+ * ```typescript
192
+ * const fileName = record.fileName;
193
+ * record.fileName = 'Arial';
194
+ * ```
116
195
  */
117
196
  get: function () {
118
197
  return this._textStyle.font;
@@ -125,7 +204,18 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
125
204
  });
126
205
  Object.defineProperty(AcDbTextStyleTableRecord.prototype, "bigFontFileName", {
127
206
  /**
128
- * The name of the big font file for this text style
207
+ * Gets or sets the name of the big font file for this text style.
208
+ *
209
+ * Big font files are used for languages that require more than 256 characters,
210
+ * such as Chinese, Japanese, and Korean.
211
+ *
212
+ * @returns The big font file name
213
+ *
214
+ * @example
215
+ * ```typescript
216
+ * const bigFontFileName = record.bigFontFileName;
217
+ * record.bigFontFileName = 'bigfont.shx';
218
+ * ```
129
219
  */
130
220
  get: function () {
131
221
  return this._textStyle.bigFont;
@@ -138,7 +228,15 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
138
228
  });
139
229
  Object.defineProperty(AcDbTextStyleTableRecord.prototype, "textStyle", {
140
230
  /**
141
- * Text style information used by renderer.
231
+ * Gets the text style information used by the renderer.
232
+ *
233
+ * @returns The text style configuration
234
+ *
235
+ * @example
236
+ * ```typescript
237
+ * const textStyle = record.textStyle;
238
+ * console.log('Font:', textStyle.font);
239
+ * ```
142
240
  */
143
241
  get: function () {
144
242
  return this._textStyle;
@@ -146,6 +244,18 @@ var AcDbTextStyleTableRecord = /** @class */ (function (_super) {
146
244
  enumerable: false,
147
245
  configurable: true
148
246
  });
247
+ /**
248
+ * Removes the file extension from a file name.
249
+ *
250
+ * @param pathName - The file path or name
251
+ * @returns The file name without extension
252
+ *
253
+ * @example
254
+ * ```typescript
255
+ * const fileName = this.getFileNameWithoutExtension('arial.ttf');
256
+ * // Returns: 'arial'
257
+ * ```
258
+ */
149
259
  AcDbTextStyleTableRecord.prototype.getFileNameWithoutExtension = function (pathName) {
150
260
  var fileName = pathName.split('/').pop();
151
261
  if (fileName) {
@@ -1 +1 @@
1
- {"version":3,"file":"AcDbTextStyleTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbTextStyleTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;GAIG;AACH;IAA8C,4CAAqB;IAIjE,kCAAY,SAA4B;QACtC,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAA;QAC1B,KAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,oDAAoD;QACpD,4DAA4D;QAC5D,KAAI,CAAC,UAAU,CAAC,IAAI,GAAG,KAAI,CAAC,2BAA2B,CACrD,KAAI,CAAC,UAAU,CAAC,IAAI,IAAI,KAAI,CAAC,UAAU,CAAC,YAAY,IAAI,KAAI,CAAC,IAAI,CAClE,CAAA;QACD,KAAI,CAAC,WAAW,GAAG,KAAK,CAAA;;IAC1B,CAAC;IAQD,sBAAI,oDAAc;QANlB;;;;;WAKG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAA;QACrC,CAAC;aACD,UAAmB,KAAa;YAC9B,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,KAAK,CAAA;QACtC,CAAC;;;OAHA;IAcD,sBAAI,+CAAS;QATb;;;;;;;;WAQG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAA;QACnC,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,KAAK,CAAA;QACpC,CAAC;;;OAHA;IAUD,sBAAI,8CAAQ;QALZ;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,CAAA;QACxC,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,UAAU,CAAC,eAAe,GAAG,KAAK,CAAA;QACzC,CAAC;;;OAHA;IAWD,sBAAI,4CAAM;QANV;;;;;WAKG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAA;QACpC,CAAC;aACD,UAAW,KAAa;YACtB,IAAI,CAAC,UAAU,CAAC,WAAW,GAAG,KAAK,CAAA;QACrC,CAAC;;;OAHA;IAQD,sBAAI,gDAAU;QAHd;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,WAAW,CAAA;QACzB,CAAC;aACD,UAAe,KAAc;YAC3B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAHA;IAQD,sBAAI,8CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAA;QAC7B,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,KAAK,CAAA;QAC9B,CAAC;;;OAHA;IAQD,sBAAI,qDAAe;QAHnB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAA;QAChC,CAAC;aACD,UAAoB,KAAa;YAC/B,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAA;QACjC,CAAC;;;OAHA;IAQD,sBAAI,+CAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;;;OAAA;IAEO,8DAA2B,GAAnC,UAAoC,QAAgB;QAClD,IAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAA;QAC1C,IAAI,QAAQ,EAAE,CAAC;YACb,sDAAsD;YACtD,IAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;YAE1C,iDAAiD;YACjD,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;gBACpB,OAAO,QAAQ,CAAA;YACjB,CAAC;YAED,+EAA+E;YAC/E,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;QACxC,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IACH,+BAAC;AAAD,CAAC,AA3HD,CAA8C,qBAAqB,GA2HlE"}
1
+ {"version":3,"file":"AcDbTextStyleTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbTextStyleTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;;;;;GAcG;AACH;IAA8C,4CAAqB;IAMjE;;;;;;;;;;;OAWG;IACH,kCAAY,SAA4B;QACtC,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAA;QAC1B,KAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,oDAAoD;QACpD,4DAA4D;QAC5D,KAAI,CAAC,UAAU,CAAC,IAAI,GAAG,KAAI,CAAC,2BAA2B,CACrD,KAAI,CAAC,UAAU,CAAC,IAAI,IAAI,KAAI,CAAC,UAAU,CAAC,YAAY,IAAI,KAAI,CAAC,IAAI,CAClE,CAAA;QACD,KAAI,CAAC,WAAW,GAAG,KAAK,CAAA;;IAC1B,CAAC;IAkBD,sBAAI,oDAAc;QAhBlB;;;;;;;;;;;;;;;WAeG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAA;QACrC,CAAC;aACD,UAAmB,KAAa;YAC9B,IAAI,CAAC,UAAU,CAAC,YAAY,GAAG,KAAK,CAAA;QACtC,CAAC;;;OAHA;IAwBD,sBAAI,+CAAS;QAnBb;;;;;;;;;;;;;;;;;;WAkBG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAA;QACnC,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,KAAK,CAAA;QACpC,CAAC;;;OAHA;IAoBD,sBAAI,8CAAQ;QAfZ;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,CAAA;QACxC,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,UAAU,CAAC,eAAe,GAAG,KAAK,CAAA;QACzC,CAAC;;;OAHA;IAoBD,sBAAI,4CAAM;QAfV;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,CAAA;QACpC,CAAC;aACD,UAAW,KAAa;YACtB,IAAI,CAAC,UAAU,CAAC,WAAW,GAAG,KAAK,CAAA;QACrC,CAAC;;;OAHA;IAkBD,sBAAI,gDAAU;QAbd;;;;;;;;;;;;WAYG;aACH;YACE,OAAO,IAAI,CAAC,WAAW,CAAA;QACzB,CAAC;aACD,UAAe,KAAc;YAC3B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAHA;IAgBD,sBAAI,8CAAQ;QAXZ;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAA;QAC7B,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,KAAK,CAAA;QAC9B,CAAC;;;OAHA;IAmBD,sBAAI,qDAAe;QAdnB;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAA;QAChC,CAAC;aACD,UAAoB,KAAa;YAC/B,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAA;QACjC,CAAC;;;OAHA;IAgBD,sBAAI,+CAAS;QAXb;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;;;OAAA;IAED;;;;;;;;;;;OAWG;IACK,8DAA2B,GAAnC,UAAoC,QAAgB;QAClD,IAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAA;QAC1C,IAAI,QAAQ,EAAE,CAAC;YACb,sDAAsD;YACtD,IAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;YAE1C,iDAAiD;YACjD,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;gBACpB,OAAO,QAAQ,CAAA;YACjB,CAAC;YAED,+EAA+E;YAC/E,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;QACxC,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IACH,+BAAC;AAAD,CAAC,AAjOD,CAA8C,qBAAqB,GAiOlE"}
@@ -2,10 +2,30 @@ import { AcDbDatabase } from './AcDbDatabase';
2
2
  import { AcDbSymbolTable } from './AcDbSymbolTable';
3
3
  import { AcDbViewportTableRecord } from './AcDbViewportTableRecord';
4
4
  /**
5
- * This class is the symbol table for viewport table records which represents viewport configurations
6
- * within AutoCAD.
5
+ * Symbol table for viewport table records.
6
+ *
7
+ * This class manages viewport table records which represent viewport configurations
8
+ * within AutoCAD. Viewports define how the drawing is displayed in different
9
+ * areas of the screen or paper space, including zoom levels, pan positions,
10
+ * and other display properties.
11
+ *
12
+ * @example
13
+ * ```typescript
14
+ * const viewportTable = new AcDbViewportTable(database);
15
+ * const viewport = viewportTable.getAt('*Active');
16
+ * ```
7
17
  */
8
18
  export declare class AcDbViewportTable extends AcDbSymbolTable<AcDbViewportTableRecord> {
19
+ /**
20
+ * Creates a new AcDbViewportTable instance.
21
+ *
22
+ * @param db - The database this viewport table belongs to
23
+ *
24
+ * @example
25
+ * ```typescript
26
+ * const viewportTable = new AcDbViewportTable(database);
27
+ * ```
28
+ */
9
29
  constructor(db: AcDbDatabase);
10
30
  }
11
31
  //# sourceMappingURL=AcDbViewportTable.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"AcDbViewportTable.d.ts","sourceRoot":"","sources":["../../src/database/AcDbViewportTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,eAAe,CAAC,uBAAuB,CAAC;gBACjE,EAAE,EAAE,YAAY;CAG7B"}
1
+ {"version":3,"file":"AcDbViewportTable.d.ts","sourceRoot":"","sources":["../../src/database/AcDbViewportTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAEnE;;;;;;;;;;;;;GAaG;AACH,qBAAa,iBAAkB,SAAQ,eAAe,CAAC,uBAAuB,CAAC;IAC7E;;;;;;;;;OASG;gBACS,EAAE,EAAE,YAAY;CAG7B"}
@@ -15,11 +15,31 @@ var __extends = (this && this.__extends) || (function () {
15
15
  })();
16
16
  import { AcDbSymbolTable } from './AcDbSymbolTable';
17
17
  /**
18
- * This class is the symbol table for viewport table records which represents viewport configurations
19
- * within AutoCAD.
18
+ * Symbol table for viewport table records.
19
+ *
20
+ * This class manages viewport table records which represent viewport configurations
21
+ * within AutoCAD. Viewports define how the drawing is displayed in different
22
+ * areas of the screen or paper space, including zoom levels, pan positions,
23
+ * and other display properties.
24
+ *
25
+ * @example
26
+ * ```typescript
27
+ * const viewportTable = new AcDbViewportTable(database);
28
+ * const viewport = viewportTable.getAt('*Active');
29
+ * ```
20
30
  */
21
31
  var AcDbViewportTable = /** @class */ (function (_super) {
22
32
  __extends(AcDbViewportTable, _super);
33
+ /**
34
+ * Creates a new AcDbViewportTable instance.
35
+ *
36
+ * @param db - The database this viewport table belongs to
37
+ *
38
+ * @example
39
+ * ```typescript
40
+ * const viewportTable = new AcDbViewportTable(database);
41
+ * ```
42
+ */
23
43
  function AcDbViewportTable(db) {
24
44
  return _super.call(this, db) || this;
25
45
  }
@@ -1 +1 @@
1
- {"version":3,"file":"AcDbViewportTable.js","sourceRoot":"","sources":["../../src/database/AcDbViewportTable.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAGnD;;;GAGG;AACH;IAAuC,qCAAwC;IAC7E,2BAAY,EAAgB;QAC1B,OAAA,MAAK,YAAC,EAAE,CAAC,SAAA;IACX,CAAC;IACH,wBAAC;AAAD,CAAC,AAJD,CAAuC,eAAe,GAIrD"}
1
+ {"version":3,"file":"AcDbViewportTable.js","sourceRoot":"","sources":["../../src/database/AcDbViewportTable.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAGnD;;;;;;;;;;;;;GAaG;AACH;IAAuC,qCAAwC;IAC7E;;;;;;;;;OASG;IACH,2BAAY,EAAgB;QAC1B,OAAA,MAAK,YAAC,EAAE,CAAC,SAAA;IACX,CAAC;IACH,wBAAC;AAAD,CAAC,AAdD,CAAuC,eAAe,GAcrD"}
@@ -2,36 +2,101 @@ import { AcGePoint2d } from '@mlightcad/geometry-engine';
2
2
  import { AcGiView } from '@mlightcad/graphic-interface';
3
3
  import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
4
4
  /**
5
- * This class represents viewport arrangements in AutoCAD.
5
+ * Represents a viewport table record in AutoCAD.
6
+ *
7
+ * This class represents viewport arrangements in AutoCAD, which define how
8
+ * the drawing is displayed in different areas of the screen or paper space.
9
+ * Viewports can have their own zoom levels, pan positions, grid settings,
10
+ * and other display properties.
11
+ *
12
+ * @example
13
+ * ```typescript
14
+ * const viewportRecord = new AcDbViewportTableRecord();
15
+ * viewportRecord.name = '*Active';
16
+ * viewportRecord.circleSides = 100;
17
+ * viewportRecord.lowerLeftCorner = new AcGePoint2d(0, 0);
18
+ * viewportRecord.upperRightCorner = new AcGePoint2d(1, 1);
19
+ * ```
6
20
  */
7
21
  export declare class AcDbViewportTableRecord extends AcDbSymbolTableRecord {
22
+ /** Number of sides used for circle tessellation */
8
23
  private _circleSides;
24
+ /** Center point of the viewport */
9
25
  private _center;
26
+ /** Lower left corner of the viewport window */
10
27
  private _lowerLeftCorner;
28
+ /** Upper right corner of the viewport window */
11
29
  private _upperRightCorner;
30
+ /** Snap base point for the viewport */
12
31
  private _snapBase;
32
+ /** Snap angle for the viewport */
13
33
  private _snapAngle;
34
+ /** Snap spacing for the viewport */
14
35
  private _snapSpacing;
36
+ /** Standard flags for the viewport */
15
37
  private _standardFlag;
38
+ /** Grid spacing for the viewport */
16
39
  private _gridSpacing;
40
+ /** Grid major spacing for the viewport */
17
41
  private _gridMajor;
42
+ /** Background object ID for the viewport */
18
43
  private _backgroundObjectId?;
44
+ /** Graphics system view configuration */
19
45
  private _gsView;
46
+ /**
47
+ * Creates a new AcDbViewportTableRecord instance.
48
+ *
49
+ * @example
50
+ * ```typescript
51
+ * const viewportRecord = new AcDbViewportTableRecord();
52
+ * ```
53
+ */
20
54
  constructor();
21
55
  /**
22
- * The circle zoom percent. It controls the number of sides to the tessellation used when displaying
23
- * curves. The value can be between 1 and 20000, with higher settings using more sides in the curve
24
- * tessellation.
56
+ * Gets or sets the circle zoom percent.
57
+ *
58
+ * This controls the number of sides to the tessellation used when displaying
59
+ * curves. The value can be between 1 and 20000, with higher settings using
60
+ * more sides in the curve tessellation.
61
+ *
62
+ * @returns The number of sides used for circle tessellation
63
+ *
64
+ * @example
65
+ * ```typescript
66
+ * const sides = viewportRecord.circleSides;
67
+ * viewportRecord.circleSides = 200; // Higher quality circles
68
+ * ```
25
69
  */
26
70
  get circleSides(): number;
27
71
  set circleSides(value: number);
72
+ /**
73
+ * Gets the center point of the viewport.
74
+ *
75
+ * @returns The center point of the viewport
76
+ *
77
+ * @example
78
+ * ```typescript
79
+ * const center = viewportRecord.center;
80
+ * ```
81
+ */
28
82
  get center(): AcGePoint2d;
29
83
  /**
30
- * The lower left corner of the viewport window. The X and Y values of this point are expressed as
31
- * a value between (0.0, 0.0) for the lower left corner of the AutoCAD graphics area and (1.0, 1.0)
32
- * for upper right corner of the AutoCAD graphics area. For example, a lower left corner value of
33
- * (0.5, 0.0) indicates that the viewport's lower left corner is along the bottom of the AutoCAD
34
- * graphics area, midway between the left and right edges of the graphics area.
84
+ * Gets or sets the lower left corner of the viewport window.
85
+ *
86
+ * The X and Y values of this point are expressed as a value between (0.0, 0.0)
87
+ * for the lower left corner of the AutoCAD graphics area and (1.0, 1.0) for
88
+ * the upper right corner of the AutoCAD graphics area. For example, a lower
89
+ * left corner value of (0.5, 0.0) indicates that the viewport's lower left
90
+ * corner is along the bottom of the AutoCAD graphics area, midway between
91
+ * the left and right edges of the graphics area.
92
+ *
93
+ * @returns The lower left corner point
94
+ *
95
+ * @example
96
+ * ```typescript
97
+ * const corner = viewportRecord.lowerLeftCorner;
98
+ * viewportRecord.lowerLeftCorner = new AcGePoint2d(0.25, 0.25);
99
+ * ```
35
100
  */
36
101
  get lowerLeftCorner(): AcGePoint2d;
37
102
  set lowerLeftCorner(value: AcGePoint2d);
@@ -1 +1 @@
1
- {"version":3,"file":"AcDbViewportTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbViewportTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAIL,QAAQ,EACT,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AA8B/D;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,OAAO,CAAC,YAAY,CAAQ;IAC5B,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,gBAAgB,CAAa;IACrC,OAAO,CAAC,iBAAiB,CAAa;IACtC,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,mBAAmB,CAAC,CAAQ;IACpC,OAAO,CAAC,OAAO,CAAU;;IAkBzB;;;;OAIG;IACH,IAAI,WAAW,IAGQ,MAAM,CAD5B;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,EAE5B;IAED,IAAI,MAAM,gBAET;IAED;;;;;;OAMG;IACH,IAAI,eAAe,IAGQ,WAAW,CADrC;IACD,IAAI,eAAe,CAAC,KAAK,EAAE,WAAW,EAErC;IAED;;;;;;OAMG;IACH,IAAI,gBAAgB,IAGQ,WAAW,CADtC;IACD,IAAI,gBAAgB,CAAC,KAAK,EAAE,WAAW,EAEtC;IAED;;OAEG;IACH,IAAI,QAAQ,IAGQ,WAAW,CAD9B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,WAAW,EAE9B;IAED;;;;OAIG;IACH,IAAI,SAAS,IAGQ,MAAM,CAD1B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;OAGG;IACH,IAAI,cAAc,IAGQ,WAAW,CADpC;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,WAAW,EAEpC;IAED;;OAEG;IACH,IAAI,SAAS,IAGQ,MAAM,CAD1B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;OAGG;IACH,IAAI,cAAc,IAGQ,WAAW,CADpC;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,WAAW,EAEpC;IA6BD,IAAI,YAAY,IAGQ,MAAM,CAD7B;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,IAAI,WAAW,YAEd;IAED;;OAEG;IACH,IAAI,kBAAkB,IAGQ,MAAM,GAAG,SAAS,CAD/C;IACD,IAAI,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAE/C;IAED;;OAEG;IACH,IAAI,MAAM,aAET;CACF"}
1
+ {"version":3,"file":"AcDbViewportTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbViewportTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAIL,QAAQ,EACT,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAiC/D;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,mDAAmD;IACnD,OAAO,CAAC,YAAY,CAAQ;IAC5B,mCAAmC;IACnC,OAAO,CAAC,OAAO,CAAa;IAC5B,+CAA+C;IAC/C,OAAO,CAAC,gBAAgB,CAAa;IACrC,gDAAgD;IAChD,OAAO,CAAC,iBAAiB,CAAa;IACtC,uCAAuC;IACvC,OAAO,CAAC,SAAS,CAAa;IAC9B,kCAAkC;IAClC,OAAO,CAAC,UAAU,CAAQ;IAC1B,oCAAoC;IACpC,OAAO,CAAC,YAAY,CAAa;IACjC,sCAAsC;IACtC,OAAO,CAAC,aAAa,CAAQ;IAC7B,oCAAoC;IACpC,OAAO,CAAC,YAAY,CAAa;IACjC,0CAA0C;IAC1C,OAAO,CAAC,UAAU,CAAQ;IAC1B,4CAA4C;IAC5C,OAAO,CAAC,mBAAmB,CAAC,CAAQ;IACpC,yCAAyC;IACzC,OAAO,CAAC,OAAO,CAAU;IAEzB;;;;;;;OAOG;;IAiBH;;;;;;;;;;;;;;OAcG;IACH,IAAI,WAAW,IAGQ,MAAM,CAD5B;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,EAE5B;IAED;;;;;;;;;OASG;IACH,IAAI,MAAM,gBAET;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,eAAe,IAGQ,WAAW,CADrC;IACD,IAAI,eAAe,CAAC,KAAK,EAAE,WAAW,EAErC;IAED;;;;;;OAMG;IACH,IAAI,gBAAgB,IAGQ,WAAW,CADtC;IACD,IAAI,gBAAgB,CAAC,KAAK,EAAE,WAAW,EAEtC;IAED;;OAEG;IACH,IAAI,QAAQ,IAGQ,WAAW,CAD9B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,WAAW,EAE9B;IAED;;;;OAIG;IACH,IAAI,SAAS,IAGQ,MAAM,CAD1B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;OAGG;IACH,IAAI,cAAc,IAGQ,WAAW,CADpC;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,WAAW,EAEpC;IAED;;OAEG;IACH,IAAI,SAAS,IAGQ,MAAM,CAD1B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;OAGG;IACH,IAAI,cAAc,IAGQ,WAAW,CADpC;IACD,IAAI,cAAc,CAAC,KAAK,EAAE,WAAW,EAEpC;IA6BD,IAAI,YAAY,IAGQ,MAAM,CAD7B;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,IAAI,WAAW,YAEd;IAED;;OAEG;IACH,IAAI,kBAAkB,IAGQ,MAAM,GAAG,SAAS,CAD/C;IACD,IAAI,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAE/C;IAED;;OAEG;IACH,IAAI,MAAM,aAET;CACF"}