@kitionstage/sdk 0.0.0-stage → 0.5.2-stage.2
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.
- package/README.md +73 -2
- package/dist/LICENSE +177 -0
- package/dist/THIRD_PARTY_NOTICES +28 -0
- package/dist/lib/assets/kitEngine.worker-3iMvwtlI.js +12732 -0
- package/dist/lib/assets/loro_wasm_bg-Gulzks_0.wasm +0 -0
- package/dist/lib/chunks/batch-BWpAyHvP.js +789 -0
- package/dist/lib/chunks/canonical-BIWfVCL-.js +87 -0
- package/dist/lib/chunks/envelope-D6MGY-ZN.js +61 -0
- package/dist/lib/chunks/replica-D8w3I4sn.js +2472 -0
- package/dist/lib/chunks/runtime-BVJHE1Pg.js +997 -0
- package/dist/lib/chunks/session-BqXC9a1-.js +281 -0
- package/dist/lib/chunks/toolIds-BCeSGHpV.js +821 -0
- package/dist/lib/chunks/workspaceTree-Destqupf.js +23 -0
- package/dist/lib/convergence/index.js +1035 -0
- package/dist/lib/convergence/node.js +8 -0
- package/dist/lib/embed-server/callbacks.js +37 -0
- package/dist/lib/embed-server/cli.js +19 -0
- package/dist/lib/embed-server/index.js +272 -0
- package/dist/lib/extensions/index.js +439 -0
- package/dist/lib/extensions/panel.html +208 -0
- package/dist/lib/extensions/runtime.js +198 -0
- package/dist/lib/extensions/sandbox.html +35 -0
- package/dist/lib/kdm/index.js +437 -0
- package/dist/lib/kit-dev-host/checkUiIds.mjs +44 -0
- package/dist/lib/kit-dev-host/index.js +308 -0
- package/dist/lib/kit-dev-host/lineRow.mjs +47 -0
- package/dist/lib/kit-dev-host/modeSmoke.mjs +178 -0
- package/dist/lib/kit-editor/index.js +6481 -0
- package/dist/lib/kit-editor/styles.css +807 -0
- package/dist/lib/kit-editor/workspaceTree.js +1 -0
- package/dist/lib/kit-engine/index.js +7 -0
- package/dist/lib/kit-host/index.js +530 -0
- package/dist/lib/kit-ui-protocol/index.js +336 -0
- package/dist/lib/node-only/embed-server-callbacks.js +2 -0
- package/dist/lib/node-only/embed-server.js +2 -0
- package/dist/lib/sync/index.js +1008 -0
- package/dist/lib/sync/openToken.js +201 -0
- package/dist/lib/sync/replicaVersions.js +51 -0
- package/dist/standalone/chunks/batch-CAGYk6m4.js +789 -0
- package/dist/standalone/chunks/client-B9xkOcvf.js +772 -0
- package/dist/standalone/chunks/collab-CTQZ9h7J.js +1022 -0
- package/dist/standalone/chunks/comment-Ds9t8xSE.js +94 -0
- package/dist/standalone/chunks/comments-uVDS8Wxp.js +41 -0
- package/dist/standalone/chunks/document-B5MMuYyN.js +324 -0
- package/dist/standalone/chunks/envelope-GX4Cynkx.js +7612 -0
- package/dist/standalone/chunks/index-BEgEEnhU.js +287 -0
- package/dist/standalone/chunks/index-EEl8hGbP.js +1967 -0
- package/dist/standalone/chunks/kits-Cp51mDlw.js +9 -0
- package/dist/standalone/chunks/replica-Di2iCPiD.js +3281 -0
- package/dist/standalone/chunks/replicaVersions-C3rJxnk9.js +50 -0
- package/dist/standalone/chunks/touched-T9jKJjxn.js +78 -0
- package/dist/standalone/index.js +12 -0
- package/dist/standalone/script/index.js +339 -0
- package/dist/standalone/script/kits/board.js +5 -0
- package/dist/standalone/script/kits/cad.js +5 -0
- package/dist/standalone/script/kits/design.js +5 -0
- package/dist/standalone/script/kits/doc.js +5 -0
- package/dist/standalone/script/kits/film.js +5 -0
- package/dist/standalone/script/kits/html.js +5 -0
- package/dist/standalone/script/kits/index.js +38 -0
- package/dist/standalone/script/kits/layout.js +5 -0
- package/dist/standalone/script/kits/motion.js +5 -0
- package/dist/standalone/script/kits/note.js +5 -0
- package/dist/standalone/script/kits/pdf.js +5 -0
- package/dist/standalone/script/kits/photo.js +5 -0
- package/dist/standalone/script/kits/scene.js +5 -0
- package/dist/standalone/script/kits/sheet.js +5 -0
- package/dist/standalone/script/kits/slide.js +5 -0
- package/dist/standalone/script/kits/table.js +5 -0
- package/dist/standalone/script/kits/vector.js +5 -0
- package/dist/standalone/script/node.js +401 -0
- package/dist/standalone/script/proxy.js +254 -0
- package/dist/types/convergence/src/adapter.d.ts +131 -0
- package/dist/types/convergence/src/engine.d.ts +66 -0
- package/dist/types/convergence/src/index.d.ts +21 -0
- package/dist/types/convergence/src/net.d.ts +52 -0
- package/dist/types/convergence/src/node.d.ts +6 -0
- package/dist/types/convergence/src/report.d.ts +56 -0
- package/dist/types/convergence/src/rng.d.ts +12 -0
- package/dist/types/convergence/src/scenarios.d.ts +15 -0
- package/dist/types/convergence/src/state.d.ts +67 -0
- package/dist/types/embed/src/agent.d.ts +88 -0
- package/dist/types/embed/src/blobs.d.ts +2 -0
- package/dist/types/embed/src/collab.d.ts +250 -0
- package/dist/types/embed/src/comments.d.ts +30 -0
- package/dist/types/embed/src/errors.d.ts +24 -0
- package/dist/types/embed/src/handlers.d.ts +92 -0
- package/dist/types/embed/src/index.d.ts +20 -0
- package/dist/types/embed/src/mount.d.ts +39 -0
- package/dist/types/embed/src/replicaStore.d.ts +3 -0
- package/dist/types/embed/src/rooms.d.ts +40 -0
- package/dist/types/embed/src/schemas.d.ts +7 -0
- package/dist/types/embed/src/syncClients.d.ts +28 -0
- package/dist/types/embed/src/theme.d.ts +7 -0
- package/dist/types/embed/src/types.d.ts +596 -0
- package/dist/types/embed/src/ui.d.ts +33 -0
- package/dist/types/embed/src/version.d.ts +2 -0
- package/dist/types/embed-server/src/callbacks.d.ts +30 -0
- package/dist/types/embed-server/src/cli.d.ts +1 -0
- package/dist/types/embed-server/src/index.d.ts +19 -0
- package/dist/types/embed-server/src/page.d.ts +15 -0
- package/dist/types/embed-server/src/server.d.ts +39 -0
- package/dist/types/embed-server/src/session.d.ts +22 -0
- package/dist/types/extensions/src/gate.d.ts +17 -0
- package/dist/types/extensions/src/generated/runtime.d.ts +8 -0
- package/dist/types/extensions/src/host.d.ts +135 -0
- package/dist/types/extensions/src/index.d.ts +13 -0
- package/dist/types/extensions/src/manifest.d.ts +82 -0
- package/dist/types/extensions/src/protocol.d.ts +159 -0
- package/dist/types/extensions/src/rpc.d.ts +52 -0
- package/dist/types/extensions/src/runtime/document.d.ts +40 -0
- package/dist/types/extensions/src/runtime/index.d.ts +10 -0
- package/dist/types/extensions/src/runtime/panel.d.ts +19 -0
- package/dist/types/extensions/src/runtime/runtime.d.ts +54 -0
- package/dist/types/extensions/src/runtime/worker.d.ts +1 -0
- package/dist/types/extensions/src/sandbox.d.ts +41 -0
- package/dist/types/kdm/src/args.d.ts +12 -0
- package/dist/types/kdm/src/batch.d.ts +118 -0
- package/dist/types/kdm/src/canonical.d.ts +25 -0
- package/dist/types/kdm/src/comment.d.ts +114 -0
- package/dist/types/kdm/src/diff.d.ts +125 -0
- package/dist/types/kdm/src/envelope.d.ts +27 -0
- package/dist/types/kdm/src/errors.d.ts +28 -0
- package/dist/types/kdm/src/footprint.d.ts +21 -0
- package/dist/types/kdm/src/ids.d.ts +57 -0
- package/dist/types/kdm/src/index.d.ts +18 -0
- package/dist/types/kdm/src/marks.d.ts +32 -0
- package/dist/types/kdm/src/op.d.ts +124 -0
- package/dist/types/kdm/src/origin.d.ts +41 -0
- package/dist/types/kdm/src/overlay.d.ts +92 -0
- package/dist/types/kdm/src/projection.d.ts +29 -0
- package/dist/types/kdm/src/read.d.ts +90 -0
- package/dist/types/kdm/src/replica.d.ts +403 -0
- package/dist/types/kdm/src/schema.d.ts +185 -0
- package/dist/types/kdm/src/testing.d.ts +28 -0
- package/dist/types/kdm/src/toolIds.d.ts +61 -0
- package/dist/types/kdm/src/touched.d.ts +24 -0
- package/dist/types/kdm/src/tx.d.ts +215 -0
- package/dist/types/kdm/src/value.d.ts +23 -0
- package/dist/types/kit-dev-host/src/checkNoPaths.d.ts +19 -0
- package/dist/types/kit-dev-host/src/checkUiIds.d.mts +2 -0
- package/dist/types/kit-dev-host/src/index.d.ts +179 -0
- package/dist/types/kit-dev-host/src/lineRow.d.mts +14 -0
- package/dist/types/kit-dev-host/src/memoryFiles.d.ts +15 -0
- package/dist/types/kit-dev-host/src/modeSmoke.d.mts +8 -0
- package/dist/types/kit-editor/src/CommandDialog.d.ts +22 -0
- package/dist/types/kit-editor/src/CommentsPanel.d.ts +45 -0
- package/dist/types/kit-editor/src/CustomizeDialog.d.ts +32 -0
- package/dist/types/kit-editor/src/HostButtons.d.ts +11 -0
- package/dist/types/kit-editor/src/RenderFailure.d.ts +7 -0
- package/dist/types/kit-editor/src/TextSink.d.ts +6 -0
- package/dist/types/kit-editor/src/brand.d.ts +2 -0
- package/dist/types/kit-editor/src/catalogMenus.d.ts +27 -0
- package/dist/types/kit-editor/src/chart.d.ts +138 -0
- package/dist/types/kit-editor/src/conflicts.d.ts +12 -0
- package/dist/types/kit-editor/src/drawing.d.ts +83 -0
- package/dist/types/kit-editor/src/editor.d.ts +544 -0
- package/dist/types/kit-editor/src/engine/KitCanvas.d.ts +70 -0
- package/dist/types/kit-editor/src/engine/backdrop.d.ts +32 -0
- package/dist/types/kit-editor/src/engine/createKitFile.d.ts +12 -0
- package/dist/types/kit-editor/src/engine/decorations.d.ts +14 -0
- package/dist/types/kit-editor/src/engine/engineOverlays.d.ts +197 -0
- package/dist/types/kit-editor/src/engine/engineTools.d.ts +116 -0
- package/dist/types/kit-editor/src/engine/kitDraft.d.ts +70 -0
- package/dist/types/kit-editor/src/engine/kitEngine.d.ts +390 -0
- package/dist/types/kit-editor/src/engine/kitEngine.worker.d.ts +30 -0
- package/dist/types/kit-editor/src/engine/kitHost.d.ts +41 -0
- package/dist/types/kit-editor/src/engine/kitModel.d.ts +32 -0
- package/dist/types/kit-editor/src/engine/kitModelRunner.d.ts +99 -0
- package/dist/types/kit-editor/src/engine/kitModule.d.ts +185 -0
- package/dist/types/kit-editor/src/engine/kitShortcuts.d.ts +32 -0
- package/dist/types/kit-editor/src/engine/kitTools.d.ts +79 -0
- package/dist/types/kit-editor/src/engine/lazyFonts.d.ts +34 -0
- package/dist/types/kit-editor/src/engine/lentFiles.d.ts +29 -0
- package/dist/types/kit-editor/src/engine/rasterViewport.d.ts +178 -0
- package/dist/types/kit-editor/src/engine/readOnly.d.ts +78 -0
- package/dist/types/kit-editor/src/engine/refusal.d.ts +39 -0
- package/dist/types/kit-editor/src/engine/replica.d.ts +23 -0
- package/dist/types/kit-editor/src/engine/useKitDocument.d.ts +154 -0
- package/dist/types/kit-editor/src/engine/workerRelay.d.ts +62 -0
- package/dist/types/kit-editor/src/files.d.ts +74 -0
- package/dist/types/kit-editor/src/frame/EditorFrame.d.ts +74 -0
- package/dist/types/kit-editor/src/frame/FocusBar.d.ts +10 -0
- package/dist/types/kit-editor/src/frame/MenuNodes.d.ts +20 -0
- package/dist/types/kit-editor/src/frame/MenuRibbon.d.ts +8 -0
- package/dist/types/kit-editor/src/frame/ModeButton.d.ts +7 -0
- package/dist/types/kit-editor/src/frame/menus.d.ts +64 -0
- package/dist/types/kit-editor/src/frame/modes.d.ts +51 -0
- package/dist/types/kit-editor/src/frame/useFrameLayout.d.ts +34 -0
- package/dist/types/kit-editor/src/host.d.ts +127 -0
- package/dist/types/kit-editor/src/index.d.ts +85 -0
- package/dist/types/kit-editor/src/ink.d.ts +26 -0
- package/dist/types/kit-editor/src/lease.d.ts +53 -0
- package/dist/types/kit-editor/src/oneInFlight.d.ts +7 -0
- package/dist/types/kit-editor/src/phrases.d.ts +25 -0
- package/dist/types/kit-editor/src/presence.d.ts +79 -0
- package/dist/types/kit-editor/src/strings.d.ts +6 -0
- package/dist/types/kit-editor/src/toolIcons.d.ts +32 -0
- package/dist/types/kit-editor/src/uiCatalog.d.ts +59 -0
- package/dist/types/kit-editor/src/uiConfig.d.ts +53 -0
- package/dist/types/kit-editor/src/uiContext.d.ts +65 -0
- package/dist/types/kit-editor/src/uiStore.d.ts +20 -0
- package/dist/types/kit-editor/src/useCommentAnchors.d.ts +29 -0
- package/dist/types/kit-editor/src/useKitSession.d.ts +115 -0
- package/dist/types/kit-editor/src/workspaceTree.d.ts +5 -0
- package/dist/types/kit-engine/src/contract.d.ts +154 -0
- package/dist/types/kit-engine/src/index.d.ts +2 -0
- package/dist/types/kit-engine/src/session.d.ts +133 -0
- package/dist/types/kit-host/src/files.d.ts +163 -0
- package/dist/types/kit-host/src/index.d.ts +315 -0
- package/dist/types/kit-ui-protocol/src/index.d.ts +1145 -0
- package/dist/types/loro-crdt.d.ts +9 -0
- package/dist/types/script/kits/board.d.ts +534 -0
- package/dist/types/script/kits/cad.d.ts +2937 -0
- package/dist/types/script/kits/design.d.ts +3213 -0
- package/dist/types/script/kits/doc.d.ts +2575 -0
- package/dist/types/script/kits/film.d.ts +4067 -0
- package/dist/types/script/kits/html.d.ts +38 -0
- package/dist/types/script/kits/index.d.ts +20 -0
- package/dist/types/script/kits/layout.d.ts +3483 -0
- package/dist/types/script/kits/motion.d.ts +4826 -0
- package/dist/types/script/kits/note.d.ts +631 -0
- package/dist/types/script/kits/pdf.d.ts +829 -0
- package/dist/types/script/kits/photo.d.ts +7574 -0
- package/dist/types/script/kits/scene.d.ts +2962 -0
- package/dist/types/script/kits/sheet.d.ts +2419 -0
- package/dist/types/script/kits/slide.d.ts +1894 -0
- package/dist/types/script/kits/table.d.ts +654 -0
- package/dist/types/script/kits/vector.d.ts +5167 -0
- package/dist/types/script/src/agentRelay.d.ts +48 -0
- package/dist/types/script/src/capabilities.d.ts +21 -0
- package/dist/types/script/src/document.d.ts +87 -0
- package/dist/types/script/src/drafts.d.ts +141 -0
- package/dist/types/script/src/exchange.d.ts +30 -0
- package/dist/types/script/src/headless.d.ts +190 -0
- package/dist/types/script/src/index.d.ts +15 -0
- package/dist/types/script/src/kitModel.d.ts +17 -0
- package/dist/types/script/src/kits.d.ts +8 -0
- package/dist/types/script/src/node.d.ts +42 -0
- package/dist/types/script/src/port.d.ts +89 -0
- package/dist/types/script/src/proxy.d.ts +132 -0
- package/dist/types/script/src/room.d.ts +162 -0
- package/dist/types/script/src/sources.d.ts +73 -0
- package/dist/types/sync/src/backoff.d.ts +9 -0
- package/dist/types/sync/src/blobSection.d.ts +23 -0
- package/dist/types/sync/src/capabilities.d.ts +20 -0
- package/dist/types/sync/src/client.d.ts +253 -0
- package/dist/types/sync/src/framing.d.ts +35 -0
- package/dist/types/sync/src/hash.d.ts +2 -0
- package/dist/types/sync/src/index.d.ts +19 -0
- package/dist/types/sync/src/leases.d.ts +82 -0
- package/dist/types/sync/src/openToken.d.ts +104 -0
- package/dist/types/sync/src/protocol.d.ts +484 -0
- package/dist/types/sync/src/relay.d.ts +52 -0
- package/dist/types/sync/src/replicaVersions.d.ts +17 -0
- package/dist/types/sync/src/saveMachine.d.ts +83 -0
- package/dist/types/sync/src/saveRun.d.ts +52 -0
- package/dist/types/sync/src/transport.d.ts +19 -0
- package/package.json +229 -4
|
@@ -0,0 +1,2937 @@
|
|
|
1
|
+
import type { CommandMap, ModelDocument, ModelList, ModelMap, ModelObject, RequestContext } from '../src/index.js';
|
|
2
|
+
import { type KitDescriptor } from '../src/kits.js';
|
|
3
|
+
type Json = null | boolean | number | string | Json[] | {
|
|
4
|
+
[key: string]: Json;
|
|
5
|
+
};
|
|
6
|
+
/** kit.cad: registered with @kition/sdk/script when this module loads. */
|
|
7
|
+
export declare const cadKit: KitDescriptor;
|
|
8
|
+
/** The fields a new `Drawing` takes (`list.add(fields)`). */
|
|
9
|
+
export type DrawingFields = {
|
|
10
|
+
parametric?: Json | null;
|
|
11
|
+
};
|
|
12
|
+
/** A `Drawing` of kit.cad. */
|
|
13
|
+
export interface Drawing extends ModelObject {
|
|
14
|
+
readonly header: ModelMap<Json>;
|
|
15
|
+
/** Read-only: the kit keeps it as it is. */
|
|
16
|
+
readonly recordIdsUsed: string | null;
|
|
17
|
+
parametric: Json | null;
|
|
18
|
+
readonly layers: ModelMap<Json>;
|
|
19
|
+
readonly linetypes: ModelMap<Json>;
|
|
20
|
+
readonly textStyles: ModelMap<Json>;
|
|
21
|
+
readonly dimStyles: ModelMap<Json>;
|
|
22
|
+
readonly mleaderStyles: ModelMap<Json>;
|
|
23
|
+
readonly tableStyles: ModelMap<Json>;
|
|
24
|
+
readonly views: ModelMap<Json>;
|
|
25
|
+
readonly ucss: ModelMap<Json>;
|
|
26
|
+
readonly layerStates: ModelMap<Json>;
|
|
27
|
+
readonly groups: ModelMap<Json>;
|
|
28
|
+
readonly plotStyleTables: ModelMap<Json>;
|
|
29
|
+
readonly blocks: ModelMap<Json>;
|
|
30
|
+
readonly layouts: ModelMap<Json>;
|
|
31
|
+
readonly model: ModelList<Entity, EntityFields>;
|
|
32
|
+
readonly constraints: ModelList<Constraint, ConstraintFields>;
|
|
33
|
+
}
|
|
34
|
+
/** The fields a new `Layer` takes (`list.add(fields)`). */
|
|
35
|
+
export type LayerFields = {
|
|
36
|
+
order: number;
|
|
37
|
+
data: Json;
|
|
38
|
+
};
|
|
39
|
+
/** A `Layer` of kit.cad. */
|
|
40
|
+
export interface Layer extends ModelObject {
|
|
41
|
+
order: number;
|
|
42
|
+
data: Json;
|
|
43
|
+
/** Read-only: the kit keeps it as it is. */
|
|
44
|
+
readonly name: string | null;
|
|
45
|
+
}
|
|
46
|
+
/** The fields a new `Linetype` takes (`list.add(fields)`). */
|
|
47
|
+
export type LinetypeFields = {
|
|
48
|
+
order: number;
|
|
49
|
+
data: Json;
|
|
50
|
+
};
|
|
51
|
+
/** A `Linetype` of kit.cad. */
|
|
52
|
+
export interface Linetype extends ModelObject {
|
|
53
|
+
order: number;
|
|
54
|
+
data: Json;
|
|
55
|
+
/** Read-only: the kit keeps it as it is. */
|
|
56
|
+
readonly name: string;
|
|
57
|
+
}
|
|
58
|
+
/** The fields a new `TextStyle` takes (`list.add(fields)`). */
|
|
59
|
+
export type TextStyleFields = {
|
|
60
|
+
order: number;
|
|
61
|
+
data: Json;
|
|
62
|
+
};
|
|
63
|
+
/** A `TextStyle` of kit.cad. */
|
|
64
|
+
export interface TextStyle extends ModelObject {
|
|
65
|
+
order: number;
|
|
66
|
+
data: Json;
|
|
67
|
+
/** Read-only: the kit keeps it as it is. */
|
|
68
|
+
readonly name: string;
|
|
69
|
+
}
|
|
70
|
+
/** The fields a new `DimStyle` takes (`list.add(fields)`). */
|
|
71
|
+
export type DimStyleFields = {
|
|
72
|
+
order: number;
|
|
73
|
+
data: Json;
|
|
74
|
+
};
|
|
75
|
+
/** A `DimStyle` of kit.cad. */
|
|
76
|
+
export interface DimStyle extends ModelObject {
|
|
77
|
+
order: number;
|
|
78
|
+
data: Json;
|
|
79
|
+
/** Read-only: the kit keeps it as it is. */
|
|
80
|
+
readonly name: string;
|
|
81
|
+
}
|
|
82
|
+
/** The fields a new `MLeaderStyle` takes (`list.add(fields)`). */
|
|
83
|
+
export type MLeaderStyleFields = {
|
|
84
|
+
order: number;
|
|
85
|
+
data: Json;
|
|
86
|
+
};
|
|
87
|
+
/** A `MLeaderStyle` of kit.cad. */
|
|
88
|
+
export interface MLeaderStyle extends ModelObject {
|
|
89
|
+
order: number;
|
|
90
|
+
data: Json;
|
|
91
|
+
/** Read-only: the kit keeps it as it is. */
|
|
92
|
+
readonly name: string;
|
|
93
|
+
}
|
|
94
|
+
/** The fields a new `TableStyle` takes (`list.add(fields)`). */
|
|
95
|
+
export type TableStyleFields = {
|
|
96
|
+
order: number;
|
|
97
|
+
data: Json;
|
|
98
|
+
};
|
|
99
|
+
/** A `TableStyle` of kit.cad. */
|
|
100
|
+
export interface TableStyle extends ModelObject {
|
|
101
|
+
order: number;
|
|
102
|
+
data: Json;
|
|
103
|
+
/** Read-only: the kit keeps it as it is. */
|
|
104
|
+
readonly name: string;
|
|
105
|
+
}
|
|
106
|
+
/** The fields a new `View` takes (`list.add(fields)`). */
|
|
107
|
+
export type ViewFields = {
|
|
108
|
+
order: number;
|
|
109
|
+
data: Json;
|
|
110
|
+
};
|
|
111
|
+
/** A `View` of kit.cad. */
|
|
112
|
+
export interface View extends ModelObject {
|
|
113
|
+
order: number;
|
|
114
|
+
data: Json;
|
|
115
|
+
/** Read-only: the kit keeps it as it is. */
|
|
116
|
+
readonly name: string | null;
|
|
117
|
+
}
|
|
118
|
+
/** The fields a new `Ucs` takes (`list.add(fields)`). */
|
|
119
|
+
export type UcsFields = {
|
|
120
|
+
order: number;
|
|
121
|
+
data: Json;
|
|
122
|
+
};
|
|
123
|
+
/** A `Ucs` of kit.cad. */
|
|
124
|
+
export interface Ucs extends ModelObject {
|
|
125
|
+
order: number;
|
|
126
|
+
data: Json;
|
|
127
|
+
/** Read-only: the kit keeps it as it is. */
|
|
128
|
+
readonly name: string;
|
|
129
|
+
}
|
|
130
|
+
/** The fields a new `LayerState` takes (`list.add(fields)`). */
|
|
131
|
+
export type LayerStateFields = {
|
|
132
|
+
order: number;
|
|
133
|
+
data: Json;
|
|
134
|
+
};
|
|
135
|
+
/** A `LayerState` of kit.cad. */
|
|
136
|
+
export interface LayerState extends ModelObject {
|
|
137
|
+
order: number;
|
|
138
|
+
data: Json;
|
|
139
|
+
/** Read-only: the kit keeps it as it is. */
|
|
140
|
+
readonly name: string;
|
|
141
|
+
}
|
|
142
|
+
/** The fields a new `Group` takes (`list.add(fields)`). */
|
|
143
|
+
export type GroupFields = {
|
|
144
|
+
order: number;
|
|
145
|
+
};
|
|
146
|
+
/** A `Group` of kit.cad. */
|
|
147
|
+
export interface Group extends ModelObject {
|
|
148
|
+
order: number;
|
|
149
|
+
readonly data: ModelMap<Json>;
|
|
150
|
+
/** Read-only: the kit keeps it as it is. */
|
|
151
|
+
readonly name: string;
|
|
152
|
+
}
|
|
153
|
+
/** The fields a new `PlotStyleTable` takes (`list.add(fields)`). */
|
|
154
|
+
export type PlotStyleTableFields = {
|
|
155
|
+
order: number;
|
|
156
|
+
data: Json;
|
|
157
|
+
};
|
|
158
|
+
/** A `PlotStyleTable` of kit.cad. */
|
|
159
|
+
export interface PlotStyleTable extends ModelObject {
|
|
160
|
+
order: number;
|
|
161
|
+
data: Json;
|
|
162
|
+
/** Read-only: the kit keeps it as it is. */
|
|
163
|
+
readonly name: string;
|
|
164
|
+
}
|
|
165
|
+
/** The fields a new `Block` takes (`list.add(fields)`). */
|
|
166
|
+
export type BlockFields = {
|
|
167
|
+
data: Json;
|
|
168
|
+
};
|
|
169
|
+
/** A `Block` of kit.cad. */
|
|
170
|
+
export interface Block extends ModelObject {
|
|
171
|
+
data: Json;
|
|
172
|
+
readonly entities: ModelList<Entity, EntityFields>;
|
|
173
|
+
/** Read-only: the kit keeps it as it is. */
|
|
174
|
+
readonly name: string | null;
|
|
175
|
+
}
|
|
176
|
+
/** The fields a new `Layout` takes (`list.add(fields)`). */
|
|
177
|
+
export type LayoutFields = {
|
|
178
|
+
order: number;
|
|
179
|
+
data: Json;
|
|
180
|
+
};
|
|
181
|
+
/** A `Layout` of kit.cad. */
|
|
182
|
+
export interface Layout extends ModelObject {
|
|
183
|
+
order: number;
|
|
184
|
+
data: Json;
|
|
185
|
+
readonly entities: ModelList<Entity, EntityFields>;
|
|
186
|
+
/** Read-only: the kit keeps it as it is. */
|
|
187
|
+
readonly name: string | null;
|
|
188
|
+
}
|
|
189
|
+
/** The fields a new `Entity` takes (`list.add(fields)`). */
|
|
190
|
+
export type EntityFields = {
|
|
191
|
+
common: Json;
|
|
192
|
+
kind: Json;
|
|
193
|
+
};
|
|
194
|
+
/** A `Entity` of kit.cad. */
|
|
195
|
+
export interface Entity extends ModelObject {
|
|
196
|
+
/** Read-only: the kit keeps it as it is. */
|
|
197
|
+
readonly description: string | null;
|
|
198
|
+
/** Read-only: the kit keeps it as it is. */
|
|
199
|
+
readonly handle: string | null;
|
|
200
|
+
common: Json;
|
|
201
|
+
/** Read-only: the kit keeps it as it is. */
|
|
202
|
+
readonly constraintState: Json | null;
|
|
203
|
+
kind: Json;
|
|
204
|
+
}
|
|
205
|
+
/** The fields a new `Constraint` takes (`list.add(fields)`). */
|
|
206
|
+
export type ConstraintFields = {
|
|
207
|
+
kind: Json;
|
|
208
|
+
refs: Json;
|
|
209
|
+
name?: string | null;
|
|
210
|
+
expr?: string | null;
|
|
211
|
+
};
|
|
212
|
+
/** A `Constraint` of kit.cad. */
|
|
213
|
+
export interface Constraint extends ModelObject {
|
|
214
|
+
kind: Json;
|
|
215
|
+
refs: Json;
|
|
216
|
+
name: string | null;
|
|
217
|
+
expr: string | null;
|
|
218
|
+
}
|
|
219
|
+
/** Every command of kit.cad, by id, with its parameters. */
|
|
220
|
+
export interface CadCommands extends CommandMap {
|
|
221
|
+
/** New Drawing... Opens a new empty drawing as a further document and makes it current: in millimetres with ISO-25 dimensions, as a new document is, or in inches with metric false. Params: {metric?: bool (default true: millimetres and ISO-25 dimensions, as a new document; false: inches)}. Changes the document. */
|
|
222
|
+
"new": {
|
|
223
|
+
metric?: boolean;
|
|
224
|
+
};
|
|
225
|
+
/** Open... Opens a DXF or DWG drawing, from a path or from base64 data with a name, as a further document and makes it current. Params: {path} | {data: base64, name}. Changes the document. */
|
|
226
|
+
"open": {
|
|
227
|
+
data?: string; /** in one of several forms of the parameters */
|
|
228
|
+
name?: string; /** in one of several forms of the parameters */
|
|
229
|
+
path?: Json;
|
|
230
|
+
};
|
|
231
|
+
/** Close. Closes the drawing at the given document index, or the current one, without saving it. Params: {index?}. Changes the document. */
|
|
232
|
+
"close": {
|
|
233
|
+
index?: number;
|
|
234
|
+
};
|
|
235
|
+
/** Close All. Closes every open drawing without saving, leaving no current document. Changes the document. */
|
|
236
|
+
"closeall": Record<string, never>;
|
|
237
|
+
/** Save. Saves the current drawing to its own file, or to the given path, in the format the file name says. Params: {path?}. Changes the document. */
|
|
238
|
+
"qsave": {
|
|
239
|
+
path?: Json;
|
|
240
|
+
};
|
|
241
|
+
/** Save As... Saves the current drawing to a new path as DXF or DWG and makes that path the drawing's file. Params: {path, format?: dxf|dwg}. Changes the document. */
|
|
242
|
+
"saveas": {
|
|
243
|
+
format?: "dxf" | "dwg";
|
|
244
|
+
path?: Json;
|
|
245
|
+
};
|
|
246
|
+
/** Switch Drawing. Makes the open drawing at the given document index the current one. Params: {index}. Changes the document. */
|
|
247
|
+
"document.switch": {
|
|
248
|
+
index?: number;
|
|
249
|
+
};
|
|
250
|
+
/** Drawing as bytes. Answers the current drawing written as DXF, base64-encoded, without saving it to a file. Params: {format?: dxf} ? {data: base64}. */
|
|
251
|
+
"document.bytes": {
|
|
252
|
+
format?: string;
|
|
253
|
+
};
|
|
254
|
+
/** Audit. Checks the drawing's database for errors (dangling references, bad handles, invalid tables) and, with fix, repairs them; answers each issue found. Params: {fix?: bool} ? {errors, fixed, issues: [{kind, location, handle?, message, fix}], message}. Changes the document. */
|
|
255
|
+
"audit": {
|
|
256
|
+
fix?: boolean;
|
|
257
|
+
};
|
|
258
|
+
/** Recover... Opens a damaged drawing from a path or base64 data, repairs what audit finds, and answers the new document's index with the issues fixed. Params: {path} | {data: base64, name} ? {index, errors, fixed, issues, message}. Changes the document. */
|
|
259
|
+
"recover": {
|
|
260
|
+
data?: string; /** in one of several forms of the parameters */
|
|
261
|
+
name?: string; /** in one of several forms of the parameters */
|
|
262
|
+
path?: Json;
|
|
263
|
+
};
|
|
264
|
+
/** Undo. Undoes the last step of the caller's undo scope (person or agent), as the U command does. Params: {scope?: "person"|"agent"}. Changes the document. */
|
|
265
|
+
"u": {
|
|
266
|
+
scope?: "person" | "agent";
|
|
267
|
+
};
|
|
268
|
+
/** Undo. Undoes the last count steps of the caller's undo scope, or of the given person or agent scope. Params: {count?: n, scope?: "person"|"agent"}. Changes the document. */
|
|
269
|
+
"undo": {
|
|
270
|
+
count?: number;
|
|
271
|
+
scope?: "person" | "agent";
|
|
272
|
+
};
|
|
273
|
+
/** Redo. Redoes the last count undone steps of the caller's undo scope, or of the given person or agent scope. Params: {count?: n, scope?: "person"|"agent"}. Changes the document. */
|
|
274
|
+
"redo": {
|
|
275
|
+
count?: number;
|
|
276
|
+
scope?: "person" | "agent";
|
|
277
|
+
};
|
|
278
|
+
/** Cut. Copies the given objects, or the selection, to the clipboard and erases them from the drawing. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
279
|
+
"cutclip": {
|
|
280
|
+
aperture?: number;
|
|
281
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
282
|
+
pick?: Array<number>;
|
|
283
|
+
};
|
|
284
|
+
/** Copy. Copies the given objects, or the selection, to the clipboard with their own coordinates; the drawing is unchanged. Params: {handles?}. Acts on `handles`. Reads the selection. */
|
|
285
|
+
"copyclip": {
|
|
286
|
+
aperture?: number;
|
|
287
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
288
|
+
pick?: Array<number>;
|
|
289
|
+
};
|
|
290
|
+
/** Copy with Base Point. Copies the given objects, or the selection, to the clipboard with a base point that a later paste places; the drawing is unchanged. Params: {handles?, base: [x,y]}. Acts on `handles`. Reads the selection. */
|
|
291
|
+
"copybase": {
|
|
292
|
+
aperture?: number;
|
|
293
|
+
base?: Array<number>;
|
|
294
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
295
|
+
pick?: Array<number>;
|
|
296
|
+
};
|
|
297
|
+
/** Paste. Pastes the clipboard's objects into the current space, putting their base point at the given point or at their original coordinates. Params: {at?: [x,y]} (where the base point lands; default: the original coordinates). Reads the part. Changes the document. */
|
|
298
|
+
"pasteclip": {
|
|
299
|
+
at?: Array<number>;
|
|
300
|
+
};
|
|
301
|
+
/** Paste as Block. Pastes the clipboard's objects as one new anonymous block reference inserted at the given point or at their original coordinates. Params: {at?: [x,y]} (insertion point; default: the original coordinates). Reads the active, part. Changes the document. */
|
|
302
|
+
"pasteblock": {
|
|
303
|
+
at?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
304
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
305
|
+
layout?: string;
|
|
306
|
+
};
|
|
307
|
+
/** Paste to Original Coordinates. Pastes the clipboard's objects at their original coordinates into a drawing other than the one they were copied from. Params: {} (only into a drawing other than the one copied from). Reads the part. Changes the document. */
|
|
308
|
+
"pasteorig": Record<string, never>;
|
|
309
|
+
/** Clear. Erases every selected object from the drawing, as Edit > Clear does. Params: {}. Reads the selection. Changes the document. */
|
|
310
|
+
"erase.selection": Record<string, never>;
|
|
311
|
+
/** Select All. Selects every selectable object in the current space and answers how many are selected. Reads the part. */
|
|
312
|
+
"selectall": Record<string, never>;
|
|
313
|
+
/** Deselect All. Clears the selection so no object is selected, and answers the selection count. Params: {}. */
|
|
314
|
+
"ai_deselect": Record<string, never>;
|
|
315
|
+
/** Select. Sets or extends the selection by handles, a window or crossing box, or a pick point, or clears it; answers the selected handles. Params: {handles: [str] (handles)} | {window: [[x,y],[x,y]], crossing?: bool} | {at: [x,y], aperture?: number (drawing units: how far from the point an object may be; default the pick box at the view, or for an agent 0.5% of the larger side of the space's extents)} | {fence: [[x,y],...]} | {clear: true} | {add?: bool}. Acts on `handles`. Reads the part, selection. */
|
|
316
|
+
"select": {
|
|
317
|
+
add?: boolean; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
318
|
+
aperture?: number; /** in one of several forms of the parameters */
|
|
319
|
+
at?: Array<number>; /** in one of several forms of the parameters */
|
|
320
|
+
clear?: boolean; /** in one of several forms of the parameters */
|
|
321
|
+
crossing?: boolean; /** in one of several forms of the parameters */
|
|
322
|
+
fence?: Array<Array<number>>; /** handles; in one of several forms of the parameters */
|
|
323
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
324
|
+
pick?: Array<number>; /** in one of several forms of the parameters */
|
|
325
|
+
window?: Array<Array<number>>;
|
|
326
|
+
};
|
|
327
|
+
/** Quick Select... Selects objects by type and a property comparison (equals, differs, greater, less, wildcard), new, appended or excluded, over the drawing or the selection. Params: {type?: "Line"|"Circle"|..., property?, operator?: "="|"!="|">"|"<"|"*" (wildcard), value?, mode?: new|append|exclude, applyTo?: drawing|selection, layer?: string (a layer name), color?} ? selected handles. Reads the part, selection. */
|
|
328
|
+
"qselect": {
|
|
329
|
+
applyTo?: "drawing" | "selection";
|
|
330
|
+
color?: string; /** a layer name */
|
|
331
|
+
layer?: string;
|
|
332
|
+
mode?: "new" | "append" | "exclude"; /** wildcard */
|
|
333
|
+
operator?: "=" | "!=" | ">" | "<" | "*";
|
|
334
|
+
property?: string;
|
|
335
|
+
type?: string;
|
|
336
|
+
value?: Json;
|
|
337
|
+
};
|
|
338
|
+
/** Quick Select Properties. Answers the object types in the drawing or selection with their counts, and the properties and operators Quick Select offers for a type. Params: {applyTo?: drawing|selection, type?} ? object types with counts and the properties available for `type`. Reads the part, selection. */
|
|
339
|
+
"qselect.info": {
|
|
340
|
+
applyTo?: "drawing" | "selection";
|
|
341
|
+
type?: string;
|
|
342
|
+
};
|
|
343
|
+
/** Zoom. Changes the view: to extents, all, a window, the previous view, in or out, a centre and height, a scale factor, or objects. Params: {mode: extents|all|window|previous|in|out|center|scale|object, p1?, p2?, center?, height?, factor?, xp?: bool (scale relative to paper space: in a viewport, `factor` paper units per model unit), limits?: bool (scale relative to the limits)} (center: `height`, or `factor` with `xp`/`limits`). Reads the part, selection. */
|
|
344
|
+
"zoom": {
|
|
345
|
+
center?: Array<number>;
|
|
346
|
+
factor?: number;
|
|
347
|
+
height?: number; /** scale relative to the limits */
|
|
348
|
+
limits?: boolean;
|
|
349
|
+
mode?: string;
|
|
350
|
+
p1?: Array<number>;
|
|
351
|
+
p2?: Array<number>; /** scale relative to paper space: in a viewport, `factor` paper units per model unit */
|
|
352
|
+
xp?: boolean;
|
|
353
|
+
};
|
|
354
|
+
/** Zoom Previous. Restores the view saved before the last zoom or pan, if there is one. Reads the part, selection. */
|
|
355
|
+
"zoom.previous": Record<string, never>;
|
|
356
|
+
/** Zoom Window. Zooms the view to fit the rectangle between two corner points. Params: {p1, p2}. Reads the part, selection. */
|
|
357
|
+
"zoom.window": {
|
|
358
|
+
p1?: Array<number>;
|
|
359
|
+
p2?: Array<number>;
|
|
360
|
+
};
|
|
361
|
+
/** Zoom In. Zooms the view in by a factor of two about its centre. Reads the part, selection. */
|
|
362
|
+
"zoom.in": Record<string, never>;
|
|
363
|
+
/** Zoom Out. Zooms the view out by a factor of two about its centre. Reads the part, selection. */
|
|
364
|
+
"zoom.out": Record<string, never>;
|
|
365
|
+
/** Zoom All. Zooms the view to show the drawing limits and every object, whichever is larger. Reads the part, selection. */
|
|
366
|
+
"zoom.all": Record<string, never>;
|
|
367
|
+
/** Zoom Extents. Zooms the view to fit the extents of every object in the current space. Reads the part, selection. */
|
|
368
|
+
"zoom.extents": Record<string, never>;
|
|
369
|
+
/** Zoom Object. Zooms the view to fit the given objects, or the selection. Params: {handles?}. Acts on `handles`. Reads the part, selection. */
|
|
370
|
+
"zoom.object": {
|
|
371
|
+
aperture?: number;
|
|
372
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
373
|
+
pick?: Array<number>;
|
|
374
|
+
};
|
|
375
|
+
/** Pan. Moves the view by a delta, from one point to another, or to a new centre, without changing the zoom. Params: {delta: [dx,dy]} | {from, to} | {center}. */
|
|
376
|
+
"pan": {
|
|
377
|
+
center?: Array<number>; /** [dx, dy]; in one of several forms of the parameters */
|
|
378
|
+
delta?: Array<number>;
|
|
379
|
+
from?: Array<number>;
|
|
380
|
+
to?: Array<number>;
|
|
381
|
+
};
|
|
382
|
+
/** Pan Left. Pans the view a step to the left. */
|
|
383
|
+
"pan.left": Record<string, never>;
|
|
384
|
+
/** Pan Right. Pans the view a step to the right. */
|
|
385
|
+
"pan.right": Record<string, never>;
|
|
386
|
+
/** Pan Up. Pans the view a step upwards. */
|
|
387
|
+
"pan.up": Record<string, never>;
|
|
388
|
+
/** Pan Down. Pans the view a step downwards. */
|
|
389
|
+
"pan.down": Record<string, never>;
|
|
390
|
+
/** Regen. Regenerates the current viewport's display from the drawing data; the drawing is unchanged. */
|
|
391
|
+
"regen": Record<string, never>;
|
|
392
|
+
/** Regen All. Regenerates the display of every viewport from the drawing data; the drawing is unchanged. */
|
|
393
|
+
"regenall": Record<string, never>;
|
|
394
|
+
/** Redraw. Repaints the current view to clear leftover marks; the drawing is unchanged. */
|
|
395
|
+
"redraw": Record<string, never>;
|
|
396
|
+
/** Set View. Sets the view to a centre point and a visible height in drawing units. Params: {center: [x,y], height}. */
|
|
397
|
+
"view.set": {
|
|
398
|
+
center?: Array<number>;
|
|
399
|
+
height?: number;
|
|
400
|
+
};
|
|
401
|
+
/** Get View. Answers the current view's centre, visible height in drawing units and viewport size in pixels. */
|
|
402
|
+
"view.get": Record<string, never>;
|
|
403
|
+
/** Switch Layout. Switches to model space or to the named paper space layout tab. Params: {name: "Model" | layout name}. */
|
|
404
|
+
"layout.set": {
|
|
405
|
+
name?: string;
|
|
406
|
+
};
|
|
407
|
+
/** Line. Draws connected line segments through the given points, closing back to the first point when closed is set. Params: {points: [[x,y],...], closed?: bool}. Reads the active, part. Changes the document. */
|
|
408
|
+
"line": {
|
|
409
|
+
closed?: boolean; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
410
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
411
|
+
layout?: string;
|
|
412
|
+
points?: Array<Array<number>>;
|
|
413
|
+
};
|
|
414
|
+
/** Polyline. Draws one lightweight polyline through the vertices, each a point or a point with bulge and start and end widths, optionally closed. Params: {vertices: [[x,y] | {p:[x,y], bulge, startWidth, endWidth}], closed?, width?} | {points: [[x,y] | {p:[x,y], bulge, startWidth, endWidth}], closed?, width?} (points: another name for vertices). Reads the active, part. Changes the document. */
|
|
415
|
+
"pline": {
|
|
416
|
+
closed?: boolean; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
417
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
418
|
+
layout?: string; /** [[x,y] | {p:[x,y], bulge, startWidth, endWidth}]; in one of several forms of the parameters */
|
|
419
|
+
points?: Array<Json>; /** [[x,y] | {p:[x,y], bulge, startWidth, endWidth}]; in one of several forms of the parameters */
|
|
420
|
+
vertices?: Array<Json>; /** in one of several forms of the parameters */
|
|
421
|
+
width?: number;
|
|
422
|
+
};
|
|
423
|
+
/** Circle. Draws a circle from a centre and radius or diameter, two diameter end points, or three points on it. Params: {center, radius} | {center, diameter} | {p1, p2} | {p1, p2, p3}. Reads the active, part. Changes the document. */
|
|
424
|
+
"circle": {
|
|
425
|
+
center?: Array<number>;
|
|
426
|
+
diameter?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
427
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
428
|
+
layout?: string;
|
|
429
|
+
p1?: Array<number>;
|
|
430
|
+
p2?: Array<number>;
|
|
431
|
+
p3?: Array<number>; /** in one of several forms of the parameters */
|
|
432
|
+
radius?: number;
|
|
433
|
+
};
|
|
434
|
+
/** Arc. Draws an arc through three points, from a centre, radius and start and end angles, or from start, centre and end points. Params: {p1, p2, p3} | {center, radius, start, end (degrees)} | {start, center, end}. Reads the active, part. Changes the document. */
|
|
435
|
+
"arc": {
|
|
436
|
+
center?: Array<number>; /** degrees; in one of several forms of the parameters */
|
|
437
|
+
end?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
438
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
439
|
+
layout?: string;
|
|
440
|
+
p1?: Array<number>;
|
|
441
|
+
p2?: Array<number>;
|
|
442
|
+
p3?: Array<number>; /** in one of several forms of the parameters */
|
|
443
|
+
radius?: number; /** in one of several forms of the parameters */
|
|
444
|
+
start?: number;
|
|
445
|
+
};
|
|
446
|
+
/** Rectangle. Draws a closed rectangular polyline from two corners, dimensions or an area, with optional rotation, fillet or chamfer corners, width, elevation and thickness. Params: {p1, p2?: [x,y] (the opposite corner; with dimensions it picks the quadrant), dimensions?: [l, w], area?: number, length?: number, breadth?: number (area with length or breadth), rotation? (deg), fillet?, chamfer?: [d1, d2], width?, elevation?, thickness?}. Reads the active, part. Changes the document. */
|
|
447
|
+
"rectang": {
|
|
448
|
+
area?: number; /** area with length or breadth */
|
|
449
|
+
breadth?: number; /** [d1, d2] */
|
|
450
|
+
chamfer?: Array<number>; /** [l, w] */
|
|
451
|
+
dimensions?: Array<Json>;
|
|
452
|
+
elevation?: number;
|
|
453
|
+
fillet?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
454
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
455
|
+
layout?: string;
|
|
456
|
+
length?: number;
|
|
457
|
+
p1?: Array<number>; /** the opposite corner; with dimensions it picks the quadrant */
|
|
458
|
+
p2?: Array<number>; /** deg */
|
|
459
|
+
rotation?: number;
|
|
460
|
+
thickness?: number;
|
|
461
|
+
width?: number;
|
|
462
|
+
};
|
|
463
|
+
/** Polygon. Draws a regular closed polygon with the given number of sides, inscribed in or circumscribed about a circle, or from one edge. Params: {sides, center, radius, inscribed?: bool, angle?: deg to a vertex (inscribed) or edge midpoint (default: bottom edge horizontal)} | {sides, edge: [[x,y],[x,y]]}. Reads the active, part. Changes the document. */
|
|
464
|
+
"polygon": {
|
|
465
|
+
angle?: number;
|
|
466
|
+
center?: Array<number>; /** in one of several forms of the parameters */
|
|
467
|
+
edge?: Array<Array<number>>; /** in one of several forms of the parameters */
|
|
468
|
+
inscribed?: boolean; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
469
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
470
|
+
layout?: string; /** in one of several forms of the parameters */
|
|
471
|
+
radius?: number;
|
|
472
|
+
sides?: number;
|
|
473
|
+
};
|
|
474
|
+
/** Ellipse. Draws an ellipse, or an elliptical arc with start and end angles, from a centre, a major axis vector and a minor-to-major ratio. Params: {center, major: [dx,dy], ratio, start?, end? (degrees)}. Reads the active, part. Changes the document. */
|
|
475
|
+
"ellipse": {
|
|
476
|
+
center?: Array<number>; /** degrees */
|
|
477
|
+
end?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
478
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
479
|
+
layout?: string; /** [dx, dy] */
|
|
480
|
+
major?: Array<number>;
|
|
481
|
+
ratio?: number;
|
|
482
|
+
start?: number;
|
|
483
|
+
};
|
|
484
|
+
/** Point. Draws a point object at a location, or one at each of the given points, in the current point style. Params: {at: [x,y]} | {points: [...]}. Reads the active, part. Changes the document. */
|
|
485
|
+
"point": {
|
|
486
|
+
at?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
487
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
488
|
+
layout?: string; /** in one of several forms of the parameters */
|
|
489
|
+
points?: Array<Json>;
|
|
490
|
+
};
|
|
491
|
+
/** Multiple Point. Draws a point object at each of the given points in the current point style. Params: {points: [...]} | {at: [x,y]}. Reads the active, part. Changes the document. */
|
|
492
|
+
"point.multiple": {
|
|
493
|
+
at?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
494
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
495
|
+
layout?: string; /** in one of several forms of the parameters */
|
|
496
|
+
points?: Array<Json>;
|
|
497
|
+
};
|
|
498
|
+
/** Construction Line. Draws an infinite construction line through two points, at an angle, horizontal or vertical, bisecting an angle, or offset from a line. Params: {base, through} | {base, angle (degrees)} | {base, hor|ver: true} | {vertex, start, end} (bisect) | {handle, distance, side} | {handle, through} (offset). Acts on `handle`. Reads the active, part. Changes the document. */
|
|
499
|
+
"xline": {
|
|
500
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
501
|
+
aperture?: number;
|
|
502
|
+
base?: Array<number>;
|
|
503
|
+
distance?: number; /** in one of several forms of the parameters */
|
|
504
|
+
end?: number;
|
|
505
|
+
handle?: string; /** one of several alternative parameters; in one of several forms of the parameters */
|
|
506
|
+
hor?: boolean; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
507
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
508
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
509
|
+
pick?: Array<number>;
|
|
510
|
+
side?: Array<number>; /** in one of several forms of the parameters */
|
|
511
|
+
start?: number;
|
|
512
|
+
through?: Array<number>; /** one of several alternative parameters; in one of several forms of the parameters */
|
|
513
|
+
ver?: boolean;
|
|
514
|
+
vertex?: Array<number>;
|
|
515
|
+
};
|
|
516
|
+
/** Ray. Draws a semi-infinite ray starting at a base point and passing through a second point. Params: {base, through}. Reads the active, part. Changes the document. */
|
|
517
|
+
"ray": {
|
|
518
|
+
base?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
519
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
520
|
+
layout?: string;
|
|
521
|
+
through?: Array<number>;
|
|
522
|
+
};
|
|
523
|
+
/** Spline. Draws a spline through fit points with optional end tangents, from control vertices, or converts a polyline into a spline. Params: {fit: [[x,y],...], closed?, knots?: chord|sqrt|uniform, startTangent?, endTangent? ([dx,dy]), tolerance?} | {control: [...], degree?} | {object: handle|true, handles?} (polyline to spline). Acts on `handles`. Reads the active, part, selection. Changes the document. */
|
|
524
|
+
"spline": {
|
|
525
|
+
aperture?: number; /** in one of several forms of the parameters */
|
|
526
|
+
closed?: boolean; /** in one of several forms of the parameters */
|
|
527
|
+
control?: Array<Json>;
|
|
528
|
+
degree?: number;
|
|
529
|
+
endTangent?: Array<number>; /** in one of several forms of the parameters */
|
|
530
|
+
fit?: Array<Array<number>>;
|
|
531
|
+
handles?: Array<string>; /** in one of several forms of the parameters */
|
|
532
|
+
knots?: "chord" | "sqrt" | "uniform"; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
533
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
534
|
+
layout?: string;
|
|
535
|
+
object?: Json; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
536
|
+
pick?: Array<number>;
|
|
537
|
+
startTangent?: Array<number>;
|
|
538
|
+
tolerance?: number;
|
|
539
|
+
};
|
|
540
|
+
/** Donut. Draws a filled ring as a wide closed polyline, from a centre and inside and outside diameters. Params: {center, inside, outside}. Reads the active, part. Changes the document. */
|
|
541
|
+
"donut": {
|
|
542
|
+
center?: Array<number>;
|
|
543
|
+
inside?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
544
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
545
|
+
layout?: string;
|
|
546
|
+
outside?: number;
|
|
547
|
+
};
|
|
548
|
+
/** Single Line Text. Draws single-line text at a point with optional height, rotation and justification, in the current text style. Params: {at, text, height?, rotation? (degrees), justify?: L|C|R|M|TL|TC|TR|ML|MC|MR|BL|BC|BR}. Reads the active, part. Changes the document. */
|
|
549
|
+
"text": {
|
|
550
|
+
at?: Array<number>;
|
|
551
|
+
height?: number;
|
|
552
|
+
justify?: "L" | "C" | "R" | "M" | "TL" | "TC" | "TR" | "ML" | "MC" | "MR" | "BL" | "BC" | "BR"; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
553
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
554
|
+
layout?: string; /** degrees */
|
|
555
|
+
rotation?: number;
|
|
556
|
+
text?: string;
|
|
557
|
+
};
|
|
558
|
+
/** Multiline Text. Draws multiline text at a point with optional height, wrap width, attachment, rotation, style and line spacing. Params: {at, text, height?, width?, attach?: 1..9, justify?: TL..BR (instead of attach), rotation?, style?, lineSpacing?, lineSpacingExact?}. Reads the active, part. Changes the document. */
|
|
559
|
+
"mtext": {
|
|
560
|
+
at?: Array<number>;
|
|
561
|
+
attach?: number;
|
|
562
|
+
height?: number;
|
|
563
|
+
justify?: "TL" | "TC" | "TR" | "ML" | "MC" | "MR" | "BL" | "BC" | "BR"; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
564
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
565
|
+
layout?: string;
|
|
566
|
+
lineSpacing?: number;
|
|
567
|
+
lineSpacingExact?: boolean;
|
|
568
|
+
rotation?: number;
|
|
569
|
+
style?: string;
|
|
570
|
+
text?: string;
|
|
571
|
+
width?: number;
|
|
572
|
+
};
|
|
573
|
+
/** Start, Center, End. Draws a counter-clockwise arc from a start point about a centre to the angle of an end point. Params: {start, center, end}. Reads the active, part. Changes the document. */
|
|
574
|
+
"arc.sce": {
|
|
575
|
+
center?: Array<number>;
|
|
576
|
+
end?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
577
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
578
|
+
layout?: string;
|
|
579
|
+
start?: Array<number>;
|
|
580
|
+
};
|
|
581
|
+
/** Start, Center, Angle. Draws an arc from a start point about a centre through an included angle; positive angles go counter-clockwise. Params: {start, center, angle (degrees, + = CCW)}. Reads the active, part. Changes the document. */
|
|
582
|
+
"arc.sca": {
|
|
583
|
+
angle?: number;
|
|
584
|
+
center?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
585
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
586
|
+
layout?: string;
|
|
587
|
+
start?: Array<number>;
|
|
588
|
+
};
|
|
589
|
+
/** Start, Center, Length. Draws an arc from a start point about a centre with the given chord length; a negative length draws the major arc. Params: {start, center, length (chord; negative = major arc)}. Reads the active, part. Changes the document. */
|
|
590
|
+
"arc.scl": {
|
|
591
|
+
center?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
592
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
593
|
+
layout?: string;
|
|
594
|
+
length?: number;
|
|
595
|
+
start?: Array<number>;
|
|
596
|
+
};
|
|
597
|
+
/** Start, End, Angle. Draws an arc between a start and an end point that sweeps the given included angle. Params: {start, end, angle (degrees, + = CCW)}. Reads the active, part. Changes the document. */
|
|
598
|
+
"arc.sea": {
|
|
599
|
+
angle?: number;
|
|
600
|
+
end?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
601
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
602
|
+
layout?: string;
|
|
603
|
+
start?: Array<number>;
|
|
604
|
+
};
|
|
605
|
+
/** Start, End, Direction. Draws an arc between a start and an end point that leaves the start point in the given tangent direction. Params: {start, end, direction (degrees | [dx,dy])}. Reads the active, part. Changes the document. */
|
|
606
|
+
"arc.sed": {
|
|
607
|
+
direction?: Json;
|
|
608
|
+
end?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
609
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
610
|
+
layout?: string;
|
|
611
|
+
start?: Array<number>;
|
|
612
|
+
};
|
|
613
|
+
/** Start, End, Radius. Draws an arc between a start and an end point with the given radius; a negative radius draws the major arc. Params: {start, end, radius (negative = major arc)}. Reads the active, part. Changes the document. */
|
|
614
|
+
"arc.ser": {
|
|
615
|
+
end?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
616
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
617
|
+
layout?: string; /** negative = major arc */
|
|
618
|
+
radius?: number;
|
|
619
|
+
start?: Array<number>;
|
|
620
|
+
};
|
|
621
|
+
/** Center, Start, End. Draws a counter-clockwise arc about a centre from a start point to the angle of an end point. Params: {center, start, end}. Reads the active, part. Changes the document. */
|
|
622
|
+
"arc.cse": {
|
|
623
|
+
center?: Array<number>;
|
|
624
|
+
end?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
625
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
626
|
+
layout?: string;
|
|
627
|
+
start?: Array<number>;
|
|
628
|
+
};
|
|
629
|
+
/** Center, Start, Angle. Draws an arc about a centre from a start point through an included angle in degrees. Params: {center, start, angle (degrees)}. Reads the active, part. Changes the document. */
|
|
630
|
+
"arc.csa": {
|
|
631
|
+
angle?: number;
|
|
632
|
+
center?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
633
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
634
|
+
layout?: string;
|
|
635
|
+
start?: Array<number>;
|
|
636
|
+
};
|
|
637
|
+
/** Center, Start, Length. Draws an arc about a centre from a start point with the given chord length. Params: {center, start, length (chord)}. Reads the active, part. Changes the document. */
|
|
638
|
+
"arc.csl": {
|
|
639
|
+
center?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
640
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
641
|
+
layout?: string;
|
|
642
|
+
length?: number;
|
|
643
|
+
start?: Array<number>;
|
|
644
|
+
};
|
|
645
|
+
/** Continue. Draws an arc tangent to the end of the last line or arc drawn, to an end point, or from a start point and direction. Params: {end} | {start, direction, end} (with only end, the arc continues tangent from the last line or arc). Reads the active, part. Changes the document. */
|
|
646
|
+
"arc.continue": {
|
|
647
|
+
direction?: Json;
|
|
648
|
+
end?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
649
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
650
|
+
layout?: string;
|
|
651
|
+
start?: Array<number>;
|
|
652
|
+
};
|
|
653
|
+
/** Center, Diameter. Draws a circle from its centre point and diameter. Params: {center, diameter}. Reads the active, part. Changes the document. */
|
|
654
|
+
"circle.cd": {
|
|
655
|
+
center?: Array<number>;
|
|
656
|
+
diameter?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
657
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
658
|
+
layout?: string;
|
|
659
|
+
};
|
|
660
|
+
/** 2 Points. Draws a circle whose diameter runs between two points. Params: {p1, p2} | {center, diameter}. Reads the active, part. Changes the document. */
|
|
661
|
+
"circle.2p": {
|
|
662
|
+
center?: Array<number>;
|
|
663
|
+
diameter?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
664
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
665
|
+
layout?: string;
|
|
666
|
+
p1?: Array<number>;
|
|
667
|
+
p2?: Array<number>;
|
|
668
|
+
};
|
|
669
|
+
/** 3 Points. Draws the circle that passes through three points. Params: {p1, p2, p3} | {center, diameter}. Reads the active, part. Changes the document. */
|
|
670
|
+
"circle.3p": {
|
|
671
|
+
center?: Array<number>;
|
|
672
|
+
diameter?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
673
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
674
|
+
layout?: string;
|
|
675
|
+
p1?: Array<number>;
|
|
676
|
+
p2?: Array<number>;
|
|
677
|
+
p3?: Array<number>;
|
|
678
|
+
};
|
|
679
|
+
/** Tan, Tan, Radius. Draws a circle of a given radius tangent to two lines, circles, arcs or polyline segments, the solution nearest the pick points. Params: {h1, p1, h2, p2, radius} (lines, circles, arcs, polyline segments; nearest solution to the picks). Reads the active, part. Changes the document. */
|
|
680
|
+
"circle.ttr": {
|
|
681
|
+
h1?: string;
|
|
682
|
+
h2?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
683
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
684
|
+
layout?: string;
|
|
685
|
+
p1?: Array<number>;
|
|
686
|
+
p2?: Array<number>;
|
|
687
|
+
radius?: number;
|
|
688
|
+
};
|
|
689
|
+
/** Tan, Tan, Tan. Draws a circle tangent to three lines, circles, arcs or polyline segments, the solution nearest the three pick points. Params: {h1, p1, h2, p2, h3, p3}. Reads the active, part. Changes the document. */
|
|
690
|
+
"circle.ttt": {
|
|
691
|
+
h1?: string;
|
|
692
|
+
h2?: string;
|
|
693
|
+
h3?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
694
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
695
|
+
layout?: string;
|
|
696
|
+
p1?: Array<number>;
|
|
697
|
+
p2?: Array<number>;
|
|
698
|
+
p3?: Array<number>;
|
|
699
|
+
};
|
|
700
|
+
/** Axis, End. Draws an ellipse from the two end points of one axis and half the length of the other, as a distance or a third point. Params: {p1, p2, distance} | {p1, p2, p3} (axis endpoints, then half the other axis). Reads the active, part. Changes the document. */
|
|
701
|
+
"ellipse.axis": {
|
|
702
|
+
distance?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
703
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
704
|
+
layout?: string;
|
|
705
|
+
p1?: Array<number>;
|
|
706
|
+
p2?: Array<number>;
|
|
707
|
+
p3?: Array<number>;
|
|
708
|
+
};
|
|
709
|
+
/** Elliptical Arc. Draws an elliptical arc between start and end angles, from a centre, major axis and ratio or from axis end points and a distance. Params: {center, major: [dx,dy], ratio, start, end (degrees)} | {p1, p2, distance, start, end}. Reads the active, part. Changes the document. */
|
|
710
|
+
"ellipse.arc": {
|
|
711
|
+
center?: Array<number>;
|
|
712
|
+
distance?: number; /** degrees; in one of several forms of the parameters */
|
|
713
|
+
end?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
714
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
715
|
+
layout?: string; /** [dx, dy]; in one of several forms of the parameters */
|
|
716
|
+
major?: Array<number>;
|
|
717
|
+
p1?: Array<number>;
|
|
718
|
+
p2?: Array<number>;
|
|
719
|
+
ratio?: number; /** in one of several forms of the parameters */
|
|
720
|
+
start?: number;
|
|
721
|
+
};
|
|
722
|
+
/** Divide. Places points or block references at equal intervals that split an object into the given number of segments, optionally aligned to it. Params: {handle, segments, block?, align?: bool}. Acts on `handle`. Reads the active, part, selection. Changes the document. */
|
|
723
|
+
"divide": {
|
|
724
|
+
align?: boolean; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
725
|
+
aperture?: number;
|
|
726
|
+
block?: string;
|
|
727
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
728
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
729
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
730
|
+
pick?: Array<number>;
|
|
731
|
+
segments?: number;
|
|
732
|
+
};
|
|
733
|
+
/** Measure. Places points or block references along an object at every given length, from one end, optionally aligned to it. Params: {handle, length, block?, align?: bool, from?: [x,y] (end to start at)}. Acts on `handle`. Reads the active, part, selection. Changes the document. */
|
|
734
|
+
"measure": {
|
|
735
|
+
align?: boolean; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
736
|
+
aperture?: number;
|
|
737
|
+
block?: string; /** end to start at */
|
|
738
|
+
from?: Array<number>;
|
|
739
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
740
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
741
|
+
layout?: string;
|
|
742
|
+
length?: number; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
743
|
+
pick?: Array<number>;
|
|
744
|
+
};
|
|
745
|
+
/** Rectangular. Draws a revision cloud of arcs from a rectangle, a polygon, a freehand path or an existing object, with optional arc length and style. Params: {p1?: [x,y], p2?: [x,y] (a rectangle), points?: [[x,y],...] (a polygon), freehand?: [[x,y],...], handle? (an object to turn into a cloud), arcLength?: number, style?: normal|calligraphy, reverse?: bool} (one of p1 with p2, points, freehand or handle). Acts on `handle`. Reads the active, part. Changes the document. */
|
|
746
|
+
"revcloud": {
|
|
747
|
+
aperture?: number;
|
|
748
|
+
arcLength?: number;
|
|
749
|
+
freehand?: Array<Array<number>>;
|
|
750
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
751
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
752
|
+
layout?: string;
|
|
753
|
+
p1?: Array<number>;
|
|
754
|
+
p2?: Array<number>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
755
|
+
pick?: Array<number>; /** a polygon */
|
|
756
|
+
points?: Array<Array<number>>;
|
|
757
|
+
reverse?: boolean;
|
|
758
|
+
style?: "normal" | "calligraphy";
|
|
759
|
+
};
|
|
760
|
+
/** Polygonal. Draws a revision cloud of arcs along the closed polygon through the given points. Params: {points?: [[x,y],...], freehand?: [[x,y],...], handle? (an object to turn into a cloud), arcLength?: number, style?: normal|calligraphy, reverse?: bool} (one of points, freehand or handle). Acts on `handle`. Reads the active, part. Changes the document. */
|
|
761
|
+
"revcloud.polygonal": {
|
|
762
|
+
aperture?: number;
|
|
763
|
+
arcLength?: number;
|
|
764
|
+
freehand?: Array<Array<number>>;
|
|
765
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
766
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
767
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
768
|
+
pick?: Array<number>;
|
|
769
|
+
points?: Array<Array<number>>;
|
|
770
|
+
reverse?: boolean;
|
|
771
|
+
style?: "normal" | "calligraphy";
|
|
772
|
+
};
|
|
773
|
+
/** Freehand. Draws a revision cloud of arcs along a freehand path through the given points. Params: {freehand?: [[x,y],...], points?: [[x,y],...], handle? (an object to turn into a cloud), arcLength?: number, style?: normal|calligraphy, reverse?: bool} (one of freehand, points or handle). Acts on `handle`. Reads the active, part. Changes the document. */
|
|
774
|
+
"revcloud.freehand": {
|
|
775
|
+
aperture?: number;
|
|
776
|
+
arcLength?: number;
|
|
777
|
+
freehand?: Array<Array<number>>;
|
|
778
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
779
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
780
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
781
|
+
pick?: Array<number>;
|
|
782
|
+
points?: Array<Array<number>>;
|
|
783
|
+
reverse?: boolean;
|
|
784
|
+
style?: "normal" | "calligraphy";
|
|
785
|
+
};
|
|
786
|
+
/** Wipeout. Draws a wipeout that masks the objects behind it, from points or a closed polyline, or sets whether wipeout frames show. Params: {points: [[x,y],...]} | {handle (closed polyline), erase?: bool} | {frames: on|off|display}. Acts on `handle`. Reads the active, part. Changes the document. */
|
|
787
|
+
"wipeout": {
|
|
788
|
+
aperture?: number; /** in one of several forms of the parameters */
|
|
789
|
+
erase?: boolean; /** in one of several forms of the parameters */
|
|
790
|
+
frames?: "on" | "off" | "display";
|
|
791
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
792
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
793
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
794
|
+
pick?: Array<number>; /** in one of several forms of the parameters */
|
|
795
|
+
points?: Array<Array<number>>;
|
|
796
|
+
};
|
|
797
|
+
/** 3D Polyline. Draws a 3D polyline of straight segments through points with optional z values, optionally closed. Params: {points: [[x,y,z?],...], closed?}. Reads the active, part. Changes the document. */
|
|
798
|
+
"3dpoly": {
|
|
799
|
+
closed?: boolean; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
800
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
801
|
+
layout?: string; /** [[x,y,z?],...] */
|
|
802
|
+
points?: Array<Json>;
|
|
803
|
+
};
|
|
804
|
+
/** Multiline. Draws a multiline as two parallel offset polylines through the points, with scale, justification and an optional close. Params: {points, scale?, justification?: top|zero|bottom, closed?} (two offset polylines). Reads the active, part. Changes the document. */
|
|
805
|
+
"mline": {
|
|
806
|
+
closed?: boolean;
|
|
807
|
+
justification?: "top" | "zero" | "bottom"; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
808
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
809
|
+
layout?: string;
|
|
810
|
+
points?: Array<Array<Json>>;
|
|
811
|
+
scale?: number;
|
|
812
|
+
};
|
|
813
|
+
/** Helix. Draws a helix as a 3D polyline from a centre, base and top radii, height, number of turns and twist direction. Params: {center, baseRadius, topRadius?, height?, turns?, ccw?} (3D polyline approximation). Reads the active, part. Changes the document. */
|
|
814
|
+
"helix": {
|
|
815
|
+
baseRadius?: number;
|
|
816
|
+
ccw?: boolean;
|
|
817
|
+
center?: Array<number>;
|
|
818
|
+
height?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
819
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
820
|
+
layout?: string;
|
|
821
|
+
topRadius?: number;
|
|
822
|
+
turns?: number;
|
|
823
|
+
};
|
|
824
|
+
/** Control Vertices. Draws a spline from control vertices with the given degree (default 3), optionally closed. Params: {control: [[x,y],...], degree?: 1..10 (default 3), closed?}. Reads the active, part. Changes the document. */
|
|
825
|
+
"spline.cv": {
|
|
826
|
+
closed?: boolean;
|
|
827
|
+
control?: Array<Array<number>>; /** 1 to 10; default 3 */
|
|
828
|
+
degree?: number; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
829
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
830
|
+
layout?: string;
|
|
831
|
+
};
|
|
832
|
+
/** Center Mark. Draws centre marks with centre lines on the CENTER linetype for the given circles and arcs. Params: {handle | handles} (circles/arcs; lines on the CENTER linetype). Acts on `handles`. Reads the active, part, selection. Changes the document. */
|
|
833
|
+
"centermark": {
|
|
834
|
+
aperture?: number;
|
|
835
|
+
handle?: string;
|
|
836
|
+
handles?: Array<string>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
837
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
838
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
839
|
+
pick?: Array<number>;
|
|
840
|
+
};
|
|
841
|
+
/** Center Line. Draws a centre line midway between two lines, on the CENTER linetype. Params: {h1, h2} (two lines). Reads the active, part. Changes the document. */
|
|
842
|
+
"centerline": {
|
|
843
|
+
h1?: string;
|
|
844
|
+
h2?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
845
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
846
|
+
layout?: string;
|
|
847
|
+
};
|
|
848
|
+
/** Linear. Draws a horizontal, vertical or rotated linear dimension between two points, or an associative one for an object, with the line at a point. Params: {p1, p2, at, rotation? (degrees; default: horizontal/vertical from `at`), text?} | {object: str (a handle), at} (associative). Reads the active, part. Changes the document. */
|
|
849
|
+
"dimlinear": {
|
|
850
|
+
at?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
851
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
852
|
+
layout?: string; /** a handle; in one of several forms of the parameters */
|
|
853
|
+
object?: string;
|
|
854
|
+
p1?: Array<number>;
|
|
855
|
+
p2?: Array<number>; /** degrees; default: horizontal/vertical from `at`; in one of several forms of the parameters */
|
|
856
|
+
rotation?: number; /** in one of several forms of the parameters */
|
|
857
|
+
text?: string;
|
|
858
|
+
};
|
|
859
|
+
/** Aligned. Draws a dimension parallel to the line between two points, its dimension line through a point, with optional override text. Params: {p1, p2, at, text?}. Reads the active, part. Changes the document. */
|
|
860
|
+
"dimaligned": {
|
|
861
|
+
at?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
862
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
863
|
+
layout?: string;
|
|
864
|
+
p1?: Array<number>;
|
|
865
|
+
p2?: Array<number>;
|
|
866
|
+
text?: string;
|
|
867
|
+
};
|
|
868
|
+
/** Radius. Draws a radius dimension for an arc or circle, or from a centre and a point on the curve. Params: {handle, at? (where the text goes; default: beyond the arrowhead)} | {center, point, at?}. Acts on `handle`. Reads the active, part, selection. Changes the document. */
|
|
869
|
+
"dimradius": {
|
|
870
|
+
aperture?: number;
|
|
871
|
+
at?: Array<number>;
|
|
872
|
+
center?: Array<number>;
|
|
873
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
874
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
875
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
876
|
+
pick?: Array<number>;
|
|
877
|
+
point?: Array<number>;
|
|
878
|
+
};
|
|
879
|
+
/** Diameter. Draws a diameter dimension for an arc or circle, or from a centre and a point on the curve. Params: {handle, at? (where the text goes; default: beyond the arrowhead)} | {center, point, at?}. Acts on `handle`. Reads the active, part, selection. Changes the document. */
|
|
880
|
+
"dimdiameter": {
|
|
881
|
+
aperture?: number;
|
|
882
|
+
at?: Array<number>;
|
|
883
|
+
center?: Array<number>;
|
|
884
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
885
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
886
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
887
|
+
pick?: Array<number>;
|
|
888
|
+
point?: Array<number>;
|
|
889
|
+
};
|
|
890
|
+
/** Angular. Draws an angular dimension from a vertex and two points, between two lines, or for an arc, with its arc through a point. Params: {vertex, p1, p2, at} | {lines: [str, str] (two handles), at} | {arc: str (a handle), at} (associative). Reads the active, part. Changes the document. */
|
|
891
|
+
"dimangular": {
|
|
892
|
+
arc?: string;
|
|
893
|
+
at?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
894
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
895
|
+
layout?: string; /** two handles; in one of several forms of the parameters */
|
|
896
|
+
lines?: Array<string>;
|
|
897
|
+
p1?: Array<number>;
|
|
898
|
+
p2?: Array<number>;
|
|
899
|
+
vertex?: Array<number>;
|
|
900
|
+
};
|
|
901
|
+
/** Arc Length. Draws an arc length dimension for an arc or polyline arc segment, its line through a point. Params: {handle, at}. Acts on `handle`. Reads the active, part, selection. Changes the document. */
|
|
902
|
+
"dimarc": {
|
|
903
|
+
aperture?: number;
|
|
904
|
+
at?: Array<number>;
|
|
905
|
+
handle?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
906
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
907
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
908
|
+
pick?: Array<number>;
|
|
909
|
+
};
|
|
910
|
+
/** Ordinate. Draws an ordinate dimension giving a feature point's x or y datum value, with its leader to a point. Params: {feature, leader, xtype?: bool}. Reads the active, part. Changes the document. */
|
|
911
|
+
"dimordinate": {
|
|
912
|
+
feature?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
913
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
914
|
+
layout?: string;
|
|
915
|
+
leader?: Array<number>;
|
|
916
|
+
xtype?: boolean;
|
|
917
|
+
};
|
|
918
|
+
/** Continue. Draws linear dimensions that continue end to end from the last linear dimension to each of the given points. Params: {points: [[x,y]...]} (continues the last linear dimension). Reads the active, part. Changes the document. */
|
|
919
|
+
"dimcontinue": {
|
|
920
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
921
|
+
layout?: string;
|
|
922
|
+
points?: Array<Json>;
|
|
923
|
+
};
|
|
924
|
+
/** Baseline. Draws linear dimensions from the first extension line of the last linear dimension to each of the given points, spaced apart. Params: {points: [[x,y]...]} (baseline from the last linear dimension). Reads the active, part. Changes the document. */
|
|
925
|
+
"dimbaseline": {
|
|
926
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
927
|
+
layout?: string;
|
|
928
|
+
points?: Array<Json>;
|
|
929
|
+
};
|
|
930
|
+
/** Quick Dimension. Draws a continuous series of linear dimensions across the end points of the given objects, horizontal or vertical, at a point. Params: {handles?, at: [x,y], vertical?: bool}. Acts on `handles`. Reads the active, part, selection. Changes the document. */
|
|
931
|
+
"qdim": {
|
|
932
|
+
aperture?: number;
|
|
933
|
+
at?: Array<number>;
|
|
934
|
+
handles?: Array<string>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
935
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
936
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
937
|
+
pick?: Array<number>;
|
|
938
|
+
vertical?: boolean;
|
|
939
|
+
};
|
|
940
|
+
/** Dimension. Draws a dimension between two points with its line at a point, choosing the dimension kind from the geometry. Params: {p1, p2, at, rotation? (degrees; default: horizontal/vertical from `at`), text?} | {object: str (a handle), at} (associative). Reads the active, part. Changes the document. */
|
|
941
|
+
"dim": {
|
|
942
|
+
at?: Array<number>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
943
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
944
|
+
layout?: string; /** a handle; in one of several forms of the parameters */
|
|
945
|
+
object?: string;
|
|
946
|
+
p1?: Array<number>;
|
|
947
|
+
p2?: Array<number>; /** degrees; default: horizontal/vertical from `at`; in one of several forms of the parameters */
|
|
948
|
+
rotation?: number; /** in one of several forms of the parameters */
|
|
949
|
+
text?: string;
|
|
950
|
+
};
|
|
951
|
+
/** Multileader. Draws a multileader from an arrow point through vertices to a landing, with mtext or a block, straight, spline or no leader. Params: {points: [[arrow], ..., [landing]] ([location] with leaderType none), text?, leaderType?: straight|spline|none, block?: name, blockAttach?: center|insertion}. Reads the active, part. Changes the document. */
|
|
952
|
+
"mleader": {
|
|
953
|
+
block?: string;
|
|
954
|
+
blockAttach?: "center" | "insertion"; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
955
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
956
|
+
layout?: string;
|
|
957
|
+
leaderType?: "straight" | "spline" | "none"; /** [[arrow], ..., [landing]] ([location] with leaderType none); [location] with leaderType none */
|
|
958
|
+
points?: Array<Json>;
|
|
959
|
+
text?: string;
|
|
960
|
+
};
|
|
961
|
+
/** Leader. Draws a leader line through the given points, with optional annotation text at its end. Params: {points: [[x,y]...], text?}. Reads the active, part. Changes the document. */
|
|
962
|
+
"leader": {
|
|
963
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
964
|
+
layout?: string;
|
|
965
|
+
points?: Array<Json>;
|
|
966
|
+
text?: string;
|
|
967
|
+
};
|
|
968
|
+
/** Update. Applies the current dimension style to the given dimensions, or the selected ones, removing their overrides. Params: {handles?}. Acts on `handles`. Reads the active, selection. Changes the document. */
|
|
969
|
+
"dimstyle.update": {
|
|
970
|
+
aperture?: number;
|
|
971
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
972
|
+
pick?: Array<number>;
|
|
973
|
+
};
|
|
974
|
+
/** Override. Overrides dimension style fields or DIM variables on the given dimensions, or clears their overrides, and can set override text. Params: {handles?, <DimStyle fields or DIM* variables: values>, clear?: bool, text?: override text}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
975
|
+
"dimoverride": {
|
|
976
|
+
DIMADEC?: Json;
|
|
977
|
+
DIMALT?: Json;
|
|
978
|
+
DIMALTD?: Json;
|
|
979
|
+
DIMALTF?: Json;
|
|
980
|
+
DIMALTRND?: Json;
|
|
981
|
+
DIMALTU?: Json;
|
|
982
|
+
DIMALTZ?: Json;
|
|
983
|
+
DIMAPOST?: Json;
|
|
984
|
+
DIMASZ?: Json;
|
|
985
|
+
DIMAUNIT?: Json;
|
|
986
|
+
DIMBLK?: Json;
|
|
987
|
+
DIMBLK1?: Json;
|
|
988
|
+
DIMBLK2?: Json;
|
|
989
|
+
DIMCEN?: Json;
|
|
990
|
+
DIMCLRD?: Json;
|
|
991
|
+
DIMCLRE?: Json;
|
|
992
|
+
DIMCLRT?: Json;
|
|
993
|
+
DIMDEC?: Json;
|
|
994
|
+
DIMDLE?: Json;
|
|
995
|
+
DIMDLI?: Json;
|
|
996
|
+
DIMDSEP?: Json;
|
|
997
|
+
DIMEXE?: Json;
|
|
998
|
+
DIMEXO?: Json;
|
|
999
|
+
DIMFRAC?: Json;
|
|
1000
|
+
DIMGAP?: Json;
|
|
1001
|
+
DIMJUST?: Json;
|
|
1002
|
+
DIMLFAC?: Json;
|
|
1003
|
+
DIMLIM?: Json;
|
|
1004
|
+
DIMLUNIT?: Json;
|
|
1005
|
+
DIMPOST?: Json;
|
|
1006
|
+
DIMRND?: Json;
|
|
1007
|
+
DIMSCALE?: Json;
|
|
1008
|
+
DIMSE1?: Json;
|
|
1009
|
+
DIMSE2?: Json;
|
|
1010
|
+
DIMTAD?: Json;
|
|
1011
|
+
DIMTDEC?: Json;
|
|
1012
|
+
DIMTFAC?: Json;
|
|
1013
|
+
DIMTIH?: Json;
|
|
1014
|
+
DIMTM?: Json;
|
|
1015
|
+
DIMTOH?: Json;
|
|
1016
|
+
DIMTOL?: Json;
|
|
1017
|
+
DIMTP?: Json;
|
|
1018
|
+
DIMTSZ?: Json;
|
|
1019
|
+
DIMTXSTY?: Json;
|
|
1020
|
+
DIMTXT?: Json;
|
|
1021
|
+
DIMTZIN?: Json;
|
|
1022
|
+
DIMZIN?: Json;
|
|
1023
|
+
alt?: Json;
|
|
1024
|
+
altDecimals?: Json;
|
|
1025
|
+
altFactor?: Json;
|
|
1026
|
+
altPost?: Json;
|
|
1027
|
+
altRound?: Json;
|
|
1028
|
+
altUnit?: Json;
|
|
1029
|
+
altZeroSuppression?: Json;
|
|
1030
|
+
angularDecimals?: Json;
|
|
1031
|
+
angularUnit?: Json;
|
|
1032
|
+
annotative?: Json; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1033
|
+
aperture?: number;
|
|
1034
|
+
arrowBlock?: Json;
|
|
1035
|
+
arrowBlock1?: Json;
|
|
1036
|
+
arrowBlock2?: Json;
|
|
1037
|
+
arrowSize?: Json;
|
|
1038
|
+
baselineSpacing?: Json;
|
|
1039
|
+
centerMark?: Json;
|
|
1040
|
+
clear?: boolean;
|
|
1041
|
+
decimalSeparator?: Json;
|
|
1042
|
+
decimals?: Json;
|
|
1043
|
+
dimLineColor?: Json;
|
|
1044
|
+
dimLineExtend?: Json;
|
|
1045
|
+
extExtend?: Json;
|
|
1046
|
+
extLineColor?: Json;
|
|
1047
|
+
extOffset?: Json;
|
|
1048
|
+
fractionFormat?: Json;
|
|
1049
|
+
handles?: Array<string>;
|
|
1050
|
+
limits?: Json;
|
|
1051
|
+
linearFactor?: Json;
|
|
1052
|
+
linearUnit?: Json; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1053
|
+
pick?: Array<number>;
|
|
1054
|
+
post?: Json;
|
|
1055
|
+
round?: Json;
|
|
1056
|
+
scale?: Json;
|
|
1057
|
+
suppressExt1?: Json;
|
|
1058
|
+
suppressExt2?: Json;
|
|
1059
|
+
text?: string;
|
|
1060
|
+
textAbove?: Json;
|
|
1061
|
+
textColor?: Json;
|
|
1062
|
+
textGap?: Json;
|
|
1063
|
+
textHeight?: Json;
|
|
1064
|
+
textInsideHorizontal?: Json;
|
|
1065
|
+
textJust?: Json;
|
|
1066
|
+
textOutsideHorizontal?: Json;
|
|
1067
|
+
textStyle?: Json;
|
|
1068
|
+
tickSize?: Json;
|
|
1069
|
+
tolDecimals?: Json;
|
|
1070
|
+
tolMinus?: Json;
|
|
1071
|
+
tolPlus?: Json;
|
|
1072
|
+
tolScale?: Json;
|
|
1073
|
+
tolZeroSuppression?: Json;
|
|
1074
|
+
tolerance?: Json;
|
|
1075
|
+
zeroSuppression?: Json;
|
|
1076
|
+
};
|
|
1077
|
+
/** Reassociate Dimensions. Reassociates the given dimensions so their definition points attach to the objects under them. Params: {handles?} (dimensions; attaches their definition points to the objects under them). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1078
|
+
"dimreassociate": {
|
|
1079
|
+
aperture?: number;
|
|
1080
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1081
|
+
pick?: Array<number>;
|
|
1082
|
+
};
|
|
1083
|
+
/** Disassociate Dimensions. Removes the associativity of the given dimensions so they no longer follow their objects. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1084
|
+
"dimdisassociate": {
|
|
1085
|
+
aperture?: number;
|
|
1086
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1087
|
+
pick?: Array<number>;
|
|
1088
|
+
};
|
|
1089
|
+
/** Home. Moves the text of the given dimensions back to its default position and angle. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1090
|
+
"dimtedit.home": {
|
|
1091
|
+
aperture?: number;
|
|
1092
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1093
|
+
pick?: Array<number>;
|
|
1094
|
+
};
|
|
1095
|
+
/** Angle. Rotates the text of the given dimensions to an angle in degrees. Params: {handles?, angle: degrees}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1096
|
+
"dimtedit.angle": {
|
|
1097
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1098
|
+
aperture?: number;
|
|
1099
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1100
|
+
pick?: Array<number>;
|
|
1101
|
+
};
|
|
1102
|
+
/** Left. Moves the text of the given linear dimensions towards the left extension line. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1103
|
+
"dimtedit.left": {
|
|
1104
|
+
aperture?: number;
|
|
1105
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1106
|
+
pick?: Array<number>;
|
|
1107
|
+
};
|
|
1108
|
+
/** Center. Centres the text of the given dimensions on the dimension line. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1109
|
+
"dimtedit.center": {
|
|
1110
|
+
aperture?: number;
|
|
1111
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1112
|
+
pick?: Array<number>;
|
|
1113
|
+
};
|
|
1114
|
+
/** Right. Moves the text of the given linear dimensions towards the right extension line. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1115
|
+
"dimtedit.right": {
|
|
1116
|
+
aperture?: number;
|
|
1117
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1118
|
+
pick?: Array<number>;
|
|
1119
|
+
};
|
|
1120
|
+
/** Dimension Text Edit. Moves the text of the given dimensions to a point, or sets it home, to an angle, left, centre or right. Params: {handles?, at?: [x,y], mode?: home|angle|left|center|right, angle?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1121
|
+
"dimtedit": {
|
|
1122
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1123
|
+
aperture?: number;
|
|
1124
|
+
at?: Array<number>;
|
|
1125
|
+
handles?: Array<string>;
|
|
1126
|
+
mode?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1127
|
+
pick?: Array<number>;
|
|
1128
|
+
};
|
|
1129
|
+
/** Dimension Space. Spaces parallel linear or angular dimensions evenly from a base dimension, by the given spacing or DIMDLI. Params: {base: str (a handle), handles: [str] (handles), spacing?: number (default DIMDLI)}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1130
|
+
"dimspace": {
|
|
1131
|
+
aperture?: number; /** a handle */
|
|
1132
|
+
base?: string; /** handles */
|
|
1133
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1134
|
+
pick?: Array<number>; /** default DIMDLI */
|
|
1135
|
+
spacing?: number;
|
|
1136
|
+
};
|
|
1137
|
+
/** Hatch... Fills areas around internal points, or inside closed objects, with a hatch pattern at a scale and angle, optionally associative. Params: {points?: [[x,y]] (internal points) | handles?: [str] (handles of closed objects), pattern?: "ANSI31", scale?, angle? (degrees), associative?}. Acts on `handles`. Reads the active, part, selection. Changes the document. */
|
|
1138
|
+
"hatch": {
|
|
1139
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1140
|
+
aperture?: number;
|
|
1141
|
+
associative?: boolean; /** handles of closed objects; one of several alternative parameters */
|
|
1142
|
+
handles?: Array<string>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
1143
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1144
|
+
layout?: string; /** like ANSI31 */
|
|
1145
|
+
pattern?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1146
|
+
pick?: Array<number>;
|
|
1147
|
+
points?: Array<Array<Json>>;
|
|
1148
|
+
scale?: number;
|
|
1149
|
+
};
|
|
1150
|
+
/** Gradient... Fills areas around internal points, or inside closed objects, with a two-colour gradient at an angle. Params: {points? | handles?, color1?, color2?, angle?}. Acts on `handles`. Reads the active, part, selection. Changes the document. */
|
|
1151
|
+
"gradient": {
|
|
1152
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1153
|
+
aperture?: number;
|
|
1154
|
+
color1?: Json;
|
|
1155
|
+
color2?: Json;
|
|
1156
|
+
handles?: Array<string>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
1157
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1158
|
+
layout?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1159
|
+
pick?: Array<number>;
|
|
1160
|
+
points?: Array<Array<number>>;
|
|
1161
|
+
};
|
|
1162
|
+
/** Boundary... Creates a closed polyline along the boundary of the area around each internal point. Params: {points: [[x,y]]}. Reads the active, part. Changes the document. */
|
|
1163
|
+
"boundary": {
|
|
1164
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1165
|
+
layout?: string;
|
|
1166
|
+
points?: Array<Array<number>>;
|
|
1167
|
+
};
|
|
1168
|
+
/** Region. Converts the given closed objects, or the selection, into regions. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1169
|
+
"region": {
|
|
1170
|
+
aperture?: number;
|
|
1171
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1172
|
+
pick?: Array<number>;
|
|
1173
|
+
};
|
|
1174
|
+
/** Hatch Edit. Changes the pattern, scale or angle of the given hatches, or the selected ones. Params: {handles?, pattern?, scale?, angle?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1175
|
+
"hatchedit": {
|
|
1176
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1177
|
+
aperture?: number;
|
|
1178
|
+
handles?: Array<string>;
|
|
1179
|
+
pattern?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1180
|
+
pick?: Array<number>;
|
|
1181
|
+
scale?: number;
|
|
1182
|
+
};
|
|
1183
|
+
/** Make... Defines a block from objects and a base point, then converts the objects to a reference of it, keeps or deletes them. Params: {name, base: [x,y], handles?, keep?: "convert"|"retain"|"delete" (default "convert"), description?}. Acts on `handles`. Reads the active, part, selection. Changes the document. */
|
|
1184
|
+
"block": {
|
|
1185
|
+
aperture?: number;
|
|
1186
|
+
base?: Array<number>;
|
|
1187
|
+
description?: string;
|
|
1188
|
+
handles?: Array<string>; /** default "convert" */
|
|
1189
|
+
keep?: "convert" | "retain" | "delete"; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
1190
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1191
|
+
layout?: string;
|
|
1192
|
+
name?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1193
|
+
pick?: Array<number>;
|
|
1194
|
+
};
|
|
1195
|
+
/** Create Block. Defines a block from objects and a base point, then deletes the objects by default (or keeps or converts them), as -BLOCK does. Params: {name, base: [x,y], handles?, keep?: "delete"|"retain"|"convert" (default "delete"), description?}. Acts on `handles`. Reads the active, part, selection. Changes the document. */
|
|
1196
|
+
"-block": {
|
|
1197
|
+
aperture?: number;
|
|
1198
|
+
base?: Array<number>;
|
|
1199
|
+
description?: string;
|
|
1200
|
+
handles?: Array<string>; /** default "delete" */
|
|
1201
|
+
keep?: "delete" | "retain" | "convert"; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
1202
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1203
|
+
layout?: string;
|
|
1204
|
+
name?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1205
|
+
pick?: Array<number>;
|
|
1206
|
+
};
|
|
1207
|
+
/** Block... Inserts a block reference at a point with scale and rotation, defining the block from a DXF or DWG file first when one is given. Params: {name ("*NAME": exploded), file?: DXF/DWG path (defines or redefines block `name`, default the file name, from its model space; base point $INSBASE), at: [x,y], scale?: number | [x, y], rotation? (degrees), basePoint?: [x,y] (block coordinates), attribs?: {TAG: value}, explode?: bool}. Reads the active, part, selection. Changes the document. */
|
|
1208
|
+
"insert": {
|
|
1209
|
+
at?: Array<number>;
|
|
1210
|
+
attribs?: {
|
|
1211
|
+
TAG?: Json;
|
|
1212
|
+
}; /** block coordinates */
|
|
1213
|
+
basePoint?: Array<number>;
|
|
1214
|
+
explode?: boolean; /** DXF/DWG path (defines or redefines block `name`, default the file name, from its model space; base point $INSBASE); defines or redefines block `name`, default the file name, from its model space; base point $INSBASE */
|
|
1215
|
+
file?: Json; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
1216
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1217
|
+
layout?: string; /** "*NAME": exploded */
|
|
1218
|
+
name?: string; /** degrees */
|
|
1219
|
+
rotation?: number;
|
|
1220
|
+
scale?: Json;
|
|
1221
|
+
};
|
|
1222
|
+
/** Define Attributes... Defines a block attribute with a tag, prompt and default value at a point, with optional height and invisibility. Params: {tag, prompt?, default?, at, height?, invisible?}. Reads the active, part. Changes the document. */
|
|
1223
|
+
"attdef": {
|
|
1224
|
+
at?: Array<number>;
|
|
1225
|
+
default?: string;
|
|
1226
|
+
height?: number;
|
|
1227
|
+
invisible?: boolean; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
1228
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1229
|
+
layout?: string;
|
|
1230
|
+
prompt?: string;
|
|
1231
|
+
tag?: string;
|
|
1232
|
+
};
|
|
1233
|
+
/** Single... Sets attribute values on one block reference by tag, and answers which changed and which tags were unknown. Params: {handle, values: {TAG: value} (tags in any case)} ? {changed, unknownTags?}. Acts on `handle`. Reads the selection. Changes the document. */
|
|
1234
|
+
"attedit": {
|
|
1235
|
+
aperture?: number;
|
|
1236
|
+
handle?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1237
|
+
pick?: Array<number>; /** tags in any case */
|
|
1238
|
+
values?: {
|
|
1239
|
+
TAG?: Json;
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
/** Global. Finds and replaces text in attribute values across block references filtered by block, tag and value, and answers how many changed. Params: {find, replace?, block?, tag?, value? (wildcard specifications, default *), handle? (one block reference), handles? (default: every block reference in the current space)} ? {changed}. Acts on `handles`. Reads the part, selection. Changes the document. */
|
|
1243
|
+
"-attedit": {
|
|
1244
|
+
aperture?: number;
|
|
1245
|
+
block?: string;
|
|
1246
|
+
find?: string;
|
|
1247
|
+
handle?: string;
|
|
1248
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1249
|
+
pick?: Array<number>;
|
|
1250
|
+
replace?: string;
|
|
1251
|
+
tag?: string;
|
|
1252
|
+
value?: Json;
|
|
1253
|
+
};
|
|
1254
|
+
/** Write Block. Writes a block, or the given objects with a base point, to a new drawing file at a path. Params: {path, name?: string (a block to write), handles? (objects to write instead of a block), base?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1255
|
+
"wblock": {
|
|
1256
|
+
aperture?: number;
|
|
1257
|
+
base?: Array<number>;
|
|
1258
|
+
handles?: Array<string>; /** a block to write */
|
|
1259
|
+
name?: string;
|
|
1260
|
+
path?: Json; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1261
|
+
pick?: Array<number>;
|
|
1262
|
+
};
|
|
1263
|
+
/** Base. Sets the drawing's insertion base point ($INSBASE) used when it is inserted as a block. Params: {at: [x,y]}. Changes the document. */
|
|
1264
|
+
"base": {
|
|
1265
|
+
at?: Array<number>;
|
|
1266
|
+
};
|
|
1267
|
+
/** Purge. Removes unused named items of one or every type (blocks, layers, styles and more) and zero-length or empty objects, matching names. Params: {type?: all|blocks|dimstyles|groups|layers|linetypes|mleaderstyles|tablestyles|textstyles|zerolength|emptytext (default all: every named type), names?: "A*,B" (default *)} ? purged. Reads the active. Changes the document. */
|
|
1268
|
+
"purge": {
|
|
1269
|
+
names?: string; /** default all: every named type */
|
|
1270
|
+
type?: "all" | "blocks" | "dimstyles" | "groups" | "layers" | "linetypes" | "mleaderstyles" | "tablestyles" | "textstyles" | "zerolength" | "emptytext";
|
|
1271
|
+
};
|
|
1272
|
+
/** List Blocks. Answers every named block definition in the drawing with its name, base point, number of objects and description. */
|
|
1273
|
+
"blocks.list": Record<string, never>;
|
|
1274
|
+
/** Block Attribute Manager... Answers the attribute definitions of the named block (tag, prompt, default and invisibility), as the Block Attribute Manager lists them. Params: {name}. */
|
|
1275
|
+
"battman": {
|
|
1276
|
+
name?: string;
|
|
1277
|
+
};
|
|
1278
|
+
/** Attribute Display. Sets how attributes display (normal, all on or all off) through ATTMODE, and answers the new value. Params: {mode: "normal" | "on" | "off"} (sets ATTMODE to 1 / 2 / 0) ? {attmode}. Changes the document. */
|
|
1279
|
+
"attdisp": {
|
|
1280
|
+
mode?: "normal" | "on" | "off";
|
|
1281
|
+
};
|
|
1282
|
+
/** Synchronize Attributes. Updates every reference of a block so its attributes match the block's current attribute definitions. Params: {name} | {handle} (a reference of the block) ? {block, references}. Acts on `handle`. Reads the selection. Changes the document. */
|
|
1283
|
+
"attsync": {
|
|
1284
|
+
aperture?: number;
|
|
1285
|
+
handle?: string; /** in one of several forms of the parameters */
|
|
1286
|
+
name?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1287
|
+
pick?: Array<number>;
|
|
1288
|
+
};
|
|
1289
|
+
/** Erase. Erases the given objects, or the selection, from the drawing. Params: {handles?: [str] (handles)} (default: selection). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1290
|
+
"erase": {
|
|
1291
|
+
aperture?: number; /** handles */
|
|
1292
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1293
|
+
pick?: Array<number>;
|
|
1294
|
+
};
|
|
1295
|
+
/** Move. Moves the given objects, or the selection, by a delta or from a base point to a target point. Params: {handles?, from?: [x,y], to?: [x,y] | delta: [dx,dy]}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1296
|
+
"move": {
|
|
1297
|
+
aperture?: number; /** [dx, dy]; one of several alternative parameters */
|
|
1298
|
+
delta?: Array<number>;
|
|
1299
|
+
from?: Array<number>;
|
|
1300
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1301
|
+
pick?: Array<number>;
|
|
1302
|
+
to?: Array<number>;
|
|
1303
|
+
};
|
|
1304
|
+
/** Copy. Copies the given objects, or the selection, by a delta or from a point to a point, once or count times. Params: {handles?, delta: [dx,dy] | from,to, count?: n}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1305
|
+
"copy": {
|
|
1306
|
+
aperture?: number;
|
|
1307
|
+
count?: number;
|
|
1308
|
+
delta?: Array<number>;
|
|
1309
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1310
|
+
pick?: Array<number>;
|
|
1311
|
+
to?: Array<number>;
|
|
1312
|
+
};
|
|
1313
|
+
/** Rotate. Rotates the given objects, or the selection, about a base point by an angle in degrees, optionally keeping the originals. Params: {handles?, base: [x,y], angle (degrees), copy?: bool}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1314
|
+
"rotate": {
|
|
1315
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1316
|
+
aperture?: number;
|
|
1317
|
+
base?: Array<number>;
|
|
1318
|
+
copy?: boolean;
|
|
1319
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1320
|
+
pick?: Array<number>;
|
|
1321
|
+
};
|
|
1322
|
+
/** Scale. Scales the given objects, or the selection, about a base point by a factor, optionally keeping the originals. Params: {handles?, base: [x,y], factor, copy?: bool}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1323
|
+
"scale": {
|
|
1324
|
+
aperture?: number;
|
|
1325
|
+
base?: Array<number>;
|
|
1326
|
+
copy?: boolean;
|
|
1327
|
+
factor?: number;
|
|
1328
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1329
|
+
pick?: Array<number>;
|
|
1330
|
+
};
|
|
1331
|
+
/** Mirror. Mirrors the given objects, or the selection, about the line through two points, optionally erasing the originals. Params: {handles?, p1, p2, erase?: bool}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1332
|
+
"mirror": {
|
|
1333
|
+
aperture?: number;
|
|
1334
|
+
erase?: boolean;
|
|
1335
|
+
handles?: Array<string>;
|
|
1336
|
+
p1?: Array<number>;
|
|
1337
|
+
p2?: Array<number>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1338
|
+
pick?: Array<number>;
|
|
1339
|
+
};
|
|
1340
|
+
/** Stretch. Moves the vertices inside a crossing window by a delta, stretching the objects that cross it and moving those wholly inside. Params: {window: [[x,y],[x,y]], delta: [dx,dy]}. Reads the part. Changes the document. */
|
|
1341
|
+
"stretch": {
|
|
1342
|
+
delta?: Array<number>;
|
|
1343
|
+
window?: Array<Array<number>>;
|
|
1344
|
+
};
|
|
1345
|
+
/** Offset. Creates a copy of an object offset by a distance towards a side point, on the source or current layer, optionally erasing it. Params: {handle, distance, side: [x,y], erase?: bool, layer?: "source"|"current"}. Acts on `handle`. Reads the active, part, selection. Changes the document. */
|
|
1346
|
+
"offset": {
|
|
1347
|
+
aperture?: number;
|
|
1348
|
+
distance?: number;
|
|
1349
|
+
erase?: boolean;
|
|
1350
|
+
handle?: string;
|
|
1351
|
+
layer?: "source" | "current"; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1352
|
+
pick?: Array<number>;
|
|
1353
|
+
side?: Array<number>;
|
|
1354
|
+
};
|
|
1355
|
+
/** Trim. Trims an object at its cutting edges where it is picked, fenced or crossed, in quick or standard mode. Params: {handle, pick: [x,y] | fence: [[x,y],...] | crossing: [[x,y],[x,y]], edges?: [str] (handles), edgeMode?: "extend"|"none", mode?: "quick"|"standard"}. Acts on `handle`. Reads the part, selection. Changes the document. */
|
|
1356
|
+
"trim": {
|
|
1357
|
+
crossing?: Array<Array<number>>;
|
|
1358
|
+
edgeMode?: "extend" | "none"; /** handles */
|
|
1359
|
+
edges?: Array<string>; /** one of several alternative parameters */
|
|
1360
|
+
fence?: Array<Array<number>>;
|
|
1361
|
+
handle?: string;
|
|
1362
|
+
mode?: "quick" | "standard";
|
|
1363
|
+
pick?: Array<number>;
|
|
1364
|
+
};
|
|
1365
|
+
/** Extend. Extends an object to its boundary edges at the end that is picked, fenced or crossed. Params: {handle, pick: [x,y] | fence: [[x,y],...] | crossing: [[x,y],[x,y]], edges?: [str] (handles), edgeMode?: "extend"|"none"}. Acts on `handle`. Reads the part, selection. Changes the document. */
|
|
1366
|
+
"extend": {
|
|
1367
|
+
crossing?: Array<Array<number>>;
|
|
1368
|
+
edgeMode?: "extend" | "none"; /** handles */
|
|
1369
|
+
edges?: Array<string>; /** one of several alternative parameters */
|
|
1370
|
+
fence?: Array<Array<number>>;
|
|
1371
|
+
handle?: string;
|
|
1372
|
+
pick?: Array<number>;
|
|
1373
|
+
};
|
|
1374
|
+
/** Fillet. Joins two lines, arcs or circles with a tangent arc of a radius, optionally trimming them, or fillets every polyline corner. Params: {h1, p1, h2, p2, radius?, trim?: bool} | {handle, polyline: true, radius?} (the first fillets lines, arcs and circles; the second every corner of a polyline). Reads the part. Changes the document. */
|
|
1375
|
+
"fillet": {
|
|
1376
|
+
h1?: string;
|
|
1377
|
+
h2?: string;
|
|
1378
|
+
handle?: string;
|
|
1379
|
+
p1?: Array<number>;
|
|
1380
|
+
p2?: Array<number>; /** in one of several forms of the parameters */
|
|
1381
|
+
polyline?: boolean; /** in one of several forms of the parameters */
|
|
1382
|
+
radius?: number; /** in one of several forms of the parameters */
|
|
1383
|
+
trim?: boolean;
|
|
1384
|
+
};
|
|
1385
|
+
/** Chamfer. Bevels the corner between two lines by two distances or a length and angle, optionally trimming, or chamfers every polyline corner. Params: {h1, p1, h2, p2, d1?, d2?, length?, angle? (degrees), trim?: bool} | {handle, polyline: true, d1?, d2?, length?, angle?} (distances d1 and d2, or length with angle). Reads the part. Changes the document. */
|
|
1386
|
+
"chamfer": {
|
|
1387
|
+
angle?: number;
|
|
1388
|
+
d1?: number;
|
|
1389
|
+
d2?: number;
|
|
1390
|
+
h1?: string;
|
|
1391
|
+
h2?: string;
|
|
1392
|
+
handle?: string;
|
|
1393
|
+
length?: number;
|
|
1394
|
+
p1?: Array<number>;
|
|
1395
|
+
p2?: Array<number>; /** in one of several forms of the parameters */
|
|
1396
|
+
polyline?: boolean; /** in one of several forms of the parameters */
|
|
1397
|
+
trim?: boolean;
|
|
1398
|
+
};
|
|
1399
|
+
/** Explode. Breaks the given compound objects (blocks, polylines, dimensions, hatches), or the selection, into their component objects. Params: {handles?}. Acts on `handles`. Reads the part, selection. Changes the document. */
|
|
1400
|
+
"explode": {
|
|
1401
|
+
aperture?: number;
|
|
1402
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1403
|
+
pick?: Array<number>;
|
|
1404
|
+
};
|
|
1405
|
+
/** Bring to Front. Moves the given objects, or the selection, to the front of the draw order. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1406
|
+
"draworder.front": {
|
|
1407
|
+
aperture?: number;
|
|
1408
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1409
|
+
pick?: Array<number>;
|
|
1410
|
+
};
|
|
1411
|
+
/** Send to Back. Moves the given objects, or the selection, to the back of the draw order. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1412
|
+
"draworder.back": {
|
|
1413
|
+
aperture?: number;
|
|
1414
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1415
|
+
pick?: Array<number>;
|
|
1416
|
+
};
|
|
1417
|
+
/** Break. Removes the part of an object between two points on it, splitting it in two or shortening it. Params: {handle, p1, p2}. Acts on `handle`. Reads the part, selection. Changes the document. */
|
|
1418
|
+
"break": {
|
|
1419
|
+
aperture?: number;
|
|
1420
|
+
handle?: string;
|
|
1421
|
+
p1?: Array<number>;
|
|
1422
|
+
p2?: Array<number>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1423
|
+
pick?: Array<number>;
|
|
1424
|
+
};
|
|
1425
|
+
/** Break At Point. Splits an object into two at one point, leaving no gap. Params: {handle, at}. Acts on `handle`. Reads the part, selection. Changes the document. */
|
|
1426
|
+
"breakatpoint": {
|
|
1427
|
+
aperture?: number;
|
|
1428
|
+
at?: Array<number>;
|
|
1429
|
+
handle?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1430
|
+
pick?: Array<number>;
|
|
1431
|
+
};
|
|
1432
|
+
/** Join. Joins the given lines, arcs, polylines or splines that meet end to end into single objects. Params: {handles?}. Acts on `handles`. Reads the part, selection. Changes the document. */
|
|
1433
|
+
"join": {
|
|
1434
|
+
aperture?: number;
|
|
1435
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1436
|
+
pick?: Array<number>;
|
|
1437
|
+
};
|
|
1438
|
+
/** Delete Duplicate Objects. Deletes duplicate and overlapping objects among the given ones, or the selection. Params: {handles?}. Acts on `handles`. Reads the part, selection. Changes the document. */
|
|
1439
|
+
"overkill": {
|
|
1440
|
+
aperture?: number;
|
|
1441
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1442
|
+
pick?: Array<number>;
|
|
1443
|
+
};
|
|
1444
|
+
/** Array. Copies objects in a rectangular, polar or path array, taking the parameters of arrayrect, arraypolar or arraypath. Params: {type?: "rectangular" (default) | "polar" | "path", handles?: [str], rows?, cols?, rowSpacing?, colSpacing?, center?: [x,y], count?, angle?, rotate?: bool, path?: str (a handle), spacing?, align?: bool}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1445
|
+
"array": {
|
|
1446
|
+
align?: boolean;
|
|
1447
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1448
|
+
aperture?: number;
|
|
1449
|
+
center?: Array<number>;
|
|
1450
|
+
colSpacing?: Json;
|
|
1451
|
+
cols?: Json;
|
|
1452
|
+
count?: number;
|
|
1453
|
+
handles?: Array<string>; /** a handle */
|
|
1454
|
+
path?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1455
|
+
pick?: Array<number>;
|
|
1456
|
+
rotate?: boolean;
|
|
1457
|
+
rowSpacing?: Json;
|
|
1458
|
+
rows?: number;
|
|
1459
|
+
spacing?: number; /** default */
|
|
1460
|
+
type?: "rectangular" | "polar" | "path";
|
|
1461
|
+
};
|
|
1462
|
+
/** Rectangular Array. Copies the given objects, or the selection, into a grid of rows and columns at the given spacings. Params: {handles?, rows, cols, rowSpacing, colSpacing}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1463
|
+
"arrayrect": {
|
|
1464
|
+
aperture?: number;
|
|
1465
|
+
colSpacing?: number;
|
|
1466
|
+
cols?: number;
|
|
1467
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1468
|
+
pick?: Array<number>;
|
|
1469
|
+
rowSpacing?: number;
|
|
1470
|
+
rows?: number;
|
|
1471
|
+
};
|
|
1472
|
+
/** Polar Array. Copies the given objects, or the selection, a number of times about a centre over an angle, optionally rotating them. Params: {handles?, center, count, angle? (degrees, default 360), rotate?: bool}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1473
|
+
"arraypolar": {
|
|
1474
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1475
|
+
aperture?: number;
|
|
1476
|
+
center?: Array<number>;
|
|
1477
|
+
count?: number;
|
|
1478
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1479
|
+
pick?: Array<number>;
|
|
1480
|
+
rotate?: boolean;
|
|
1481
|
+
};
|
|
1482
|
+
/** Polyline. Edits polylines: close, open, join, width, fit, spline, decurve, reverse, linetype generation, or edit one vertex. Params: {handle | handles, option: close|open|join|width|fit|spline|decurve|reverse|ltypegen|vertex, width?, handles2? (join), fuzz?, action?: move|insert|straighten|width, index?, to?, startWidth?, endWidth?, convert?: bool}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1483
|
+
"pedit": {
|
|
1484
|
+
action?: "move" | "insert" | "straighten" | "width"; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1485
|
+
aperture?: number;
|
|
1486
|
+
convert?: boolean;
|
|
1487
|
+
endWidth?: number;
|
|
1488
|
+
fuzz?: number;
|
|
1489
|
+
handle?: string;
|
|
1490
|
+
handles?: Array<string>;
|
|
1491
|
+
handles2?: Array<string>; /** a position counted from 0 (the first is 0) */
|
|
1492
|
+
index?: number;
|
|
1493
|
+
option?: "close" | "open" | "join" | "width" | "fit" | "spline" | "decurve" | "reverse" | "ltypegen" | "vertex"; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1494
|
+
pick?: Array<number>;
|
|
1495
|
+
startWidth?: number;
|
|
1496
|
+
to?: Array<number>;
|
|
1497
|
+
width?: number;
|
|
1498
|
+
};
|
|
1499
|
+
/** Spline. Edits a spline: close, open, reverse, refit, purge fit data, convert to a polyline, or move a fit or control point. Params: {handle, option: close|open|reverse|refit|purge|polyline|move, fit?, index?, to?, precision?}. Acts on `handle`. Reads the selection. Changes the document. */
|
|
1500
|
+
"splinedit": {
|
|
1501
|
+
aperture?: number;
|
|
1502
|
+
fit?: Array<Array<Json>>;
|
|
1503
|
+
handle?: string; /** a position counted from 0 (the first is 0) */
|
|
1504
|
+
index?: number;
|
|
1505
|
+
option?: "close" | "open" | "reverse" | "refit" | "purge" | "polyline" | "move"; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1506
|
+
pick?: Array<number>;
|
|
1507
|
+
precision?: number;
|
|
1508
|
+
to?: Array<number>;
|
|
1509
|
+
};
|
|
1510
|
+
/** Lengthen. Changes an object's length at the picked end by a delta, percent, total or to a point, or alone measures its length. Params: {handle, pick?: [x,y] (end), delta? | deltaAngle? (deg) | percent? | total? | totalAngle? (deg) | to?: [x,y]} ({handle} alone measures). Acts on `handle`. Reads the selection. Changes the document. */
|
|
1511
|
+
"lengthen": {
|
|
1512
|
+
delta?: number;
|
|
1513
|
+
deltaAngle?: number;
|
|
1514
|
+
handle?: string;
|
|
1515
|
+
percent?: number; /** end */
|
|
1516
|
+
pick?: Array<number>; /** one of several alternative parameters */
|
|
1517
|
+
to?: Array<number>;
|
|
1518
|
+
total?: number;
|
|
1519
|
+
totalAngle?: number;
|
|
1520
|
+
};
|
|
1521
|
+
/** Align. Moves and rotates objects so one or two source points meet destination points, optionally scaling them to fit. Params: {handles?, s1, d1, s2?, d2?, scale?: bool}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1522
|
+
"align": {
|
|
1523
|
+
aperture?: number;
|
|
1524
|
+
d1?: Array<number>;
|
|
1525
|
+
d2?: Array<number>;
|
|
1526
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1527
|
+
pick?: Array<number>;
|
|
1528
|
+
s1?: Array<number>;
|
|
1529
|
+
s2?: Array<number>;
|
|
1530
|
+
scale?: boolean;
|
|
1531
|
+
};
|
|
1532
|
+
/** Blend. Draws a spline that joins the picked ends of two open curves with tangent or smooth continuity. Params: {h1, p1, h2, p2, continuity?: tangent|smooth}. Reads the active, part. Changes the document. */
|
|
1533
|
+
"blend": {
|
|
1534
|
+
continuity?: "tangent" | "smooth";
|
|
1535
|
+
h1?: string;
|
|
1536
|
+
h2?: string; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
1537
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1538
|
+
layout?: string;
|
|
1539
|
+
p1?: Array<number>;
|
|
1540
|
+
p2?: Array<number>;
|
|
1541
|
+
};
|
|
1542
|
+
/** Reverse. Reverses the vertex order of the given lines, polylines, 3D polylines and splines. Params: {handles?} (lines, polylines, 3D polylines, splines). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1543
|
+
"reverse": {
|
|
1544
|
+
aperture?: number;
|
|
1545
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1546
|
+
pick?: Array<number>;
|
|
1547
|
+
};
|
|
1548
|
+
/** Copy Nested Objects. Copies objects nested inside a block reference, the one nearest a pick or all, out into the drawing by a delta or points. Params: {handle (block reference), pick?: [x,y] (nearest nested object; default all), delta?: [dx,dy], from?: [x,y], to?: [x,y]} (delta, or from with to). Acts on `handle`. Reads the part, selection. Changes the document. */
|
|
1549
|
+
"ncopy": {
|
|
1550
|
+
delta?: Array<number>;
|
|
1551
|
+
from?: Array<number>;
|
|
1552
|
+
handle?: string; /** nearest nested object; default all */
|
|
1553
|
+
pick?: Array<number>;
|
|
1554
|
+
to?: Array<number>;
|
|
1555
|
+
};
|
|
1556
|
+
/** Change Space. Moves the given objects between model space and a layout's paper space through a viewport, keeping their apparent size. Params: {handles?, to?: "model" | layout name, viewport?: handle}. Acts on `handles`. Reads the part, selection. Changes the document. */
|
|
1557
|
+
"chspace": {
|
|
1558
|
+
aperture?: number;
|
|
1559
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1560
|
+
pick?: Array<number>;
|
|
1561
|
+
to?: string;
|
|
1562
|
+
viewport?: string;
|
|
1563
|
+
};
|
|
1564
|
+
/** Flatten Objects. Flattens the given objects, or the selection, onto z = 0, turning 3D polylines into 2D polylines. Params: {handles?} (z = 0, 3D polylines become polylines). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1565
|
+
"flatten": {
|
|
1566
|
+
aperture?: number;
|
|
1567
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1568
|
+
pick?: Array<number>;
|
|
1569
|
+
};
|
|
1570
|
+
/** Path Array. Copies the given objects, or the selection, along a path object, a count of copies or at a spacing, optionally aligned to it. Params: {handles?, path (handle), count? (default 6), spacing?: number (instead of count), align?: bool (default true)}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1571
|
+
"arraypath": {
|
|
1572
|
+
align?: boolean; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1573
|
+
aperture?: number;
|
|
1574
|
+
count?: number;
|
|
1575
|
+
handles?: Array<string>; /** handle */
|
|
1576
|
+
path?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1577
|
+
pick?: Array<number>; /** instead of count */
|
|
1578
|
+
spacing?: number;
|
|
1579
|
+
};
|
|
1580
|
+
/** Edit Text... Replaces the contents of a text, mtext, attribute definition, or a dimension's override text. Params: {handle, text} (text, mtext, attribute definitions, dimension text override). Acts on `handle`. Reads the selection. Changes the document. */
|
|
1581
|
+
"textedit": {
|
|
1582
|
+
aperture?: number;
|
|
1583
|
+
handle?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1584
|
+
pick?: Array<number>;
|
|
1585
|
+
text?: string;
|
|
1586
|
+
};
|
|
1587
|
+
/** Group. Makes a named or anonymous group of the given objects, or the selection, and answers its name and members. Params: {name? (default: an unnamed group *A1, *A2...), description?, handles? (default the selection), selectable?: bool (default true)} ? {name, members}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1588
|
+
"group": {
|
|
1589
|
+
aperture?: number;
|
|
1590
|
+
description?: string;
|
|
1591
|
+
handles?: Array<string>; /** default: an unnamed group *A1, *A2... */
|
|
1592
|
+
name?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1593
|
+
pick?: Array<number>; /** default true */
|
|
1594
|
+
selectable?: boolean;
|
|
1595
|
+
};
|
|
1596
|
+
/** Ungroup. Dissolves the named groups, or every group holding one of the given or selected objects, and answers the groups removed. Params: {name?: "G1" | "G1,G2" | [names]} | {handles?} (default the selection: every group holding one of the objects) ? {ungrouped: [names]}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1597
|
+
"ungroup": {
|
|
1598
|
+
aperture?: number;
|
|
1599
|
+
handles?: Array<string>;
|
|
1600
|
+
name?: Json; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1601
|
+
pick?: Array<number>;
|
|
1602
|
+
};
|
|
1603
|
+
/** Group Edit. Adds objects to a group, removes them, or renames it, and answers its members; removing every member deletes the group. Params: {name, add?: [handles], remove?: [handles], rename?: new name} ? {name, members}. Removing every member deletes the group. Changes the document. */
|
|
1604
|
+
"groupedit": {
|
|
1605
|
+
add?: Array<Json>;
|
|
1606
|
+
name?: string; /** [handles] */
|
|
1607
|
+
remove?: Array<Json>;
|
|
1608
|
+
rename?: string;
|
|
1609
|
+
};
|
|
1610
|
+
/** List Groups. Answers every group in the drawing with its name, description, selectability, whether it is unnamed, and its member handles. Params: {} ? {groups: [{name, description, selectable, unnamed, members: [handles]}]}. */
|
|
1611
|
+
"groups.list": Record<string, never>;
|
|
1612
|
+
/** Grip Stretch. Stretches one grip of the given objects to a point, or with mode move moves the objects from a grip, optionally copying them. Params: {handle?, handles?, index, to} | {handles?, index, base?: [x,y], baseHandle?, to, mode: "move", copy?} (the first stretches the grip; the second moves about it). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1613
|
+
"grip.move": {
|
|
1614
|
+
aperture?: number; /** in one of several forms of the parameters */
|
|
1615
|
+
base?: Array<number>;
|
|
1616
|
+
baseHandle?: string; /** in one of several forms of the parameters */
|
|
1617
|
+
copy?: boolean;
|
|
1618
|
+
handle?: string;
|
|
1619
|
+
handles?: Array<string>; /** a position counted from 0 (the first is 0); in one of several forms of the parameters */
|
|
1620
|
+
index?: number; /** like move; in one of several forms of the parameters */
|
|
1621
|
+
mode?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1622
|
+
pick?: Array<number>;
|
|
1623
|
+
to?: Array<number>;
|
|
1624
|
+
};
|
|
1625
|
+
/** Grip Stretch. Stretches the grip at an index of the given objects to a target point, as dragging a grip does. Params: {handle?, handles?, index, to}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1626
|
+
"grip.stretch": {
|
|
1627
|
+
aperture?: number;
|
|
1628
|
+
handle?: string;
|
|
1629
|
+
handles?: Array<string>; /** a position counted from 0 (the first is 0) */
|
|
1630
|
+
index?: number; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1631
|
+
pick?: Array<number>;
|
|
1632
|
+
to?: Array<number>;
|
|
1633
|
+
};
|
|
1634
|
+
/** Grip Rotate. Rotates the given objects about a base point or a grip, by an angle or towards a point, optionally copying them. Params: {handles?, base?: [x,y], baseHandle?, index?, angle? (degrees), to?: [x,y], copy?: bool} (the base point: base, or baseHandle with index; the angle: angle, or to). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1635
|
+
"grip.rotate": {
|
|
1636
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1637
|
+
aperture?: number;
|
|
1638
|
+
base?: Array<number>;
|
|
1639
|
+
baseHandle?: string;
|
|
1640
|
+
copy?: boolean;
|
|
1641
|
+
handles?: Array<string>; /** a position counted from 0 (the first is 0) */
|
|
1642
|
+
index?: number; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1643
|
+
pick?: Array<number>;
|
|
1644
|
+
to?: Array<number>;
|
|
1645
|
+
};
|
|
1646
|
+
/** Grip Scale. Scales the given objects about a base point or a grip, by a factor or towards a point, optionally copying them. Params: {handles?, base?: [x,y], baseHandle?, index?, factor?: number, to?: [x,y], copy?: bool} (the base point: base, or baseHandle with index; the scale: factor, or to). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1647
|
+
"grip.scale": {
|
|
1648
|
+
aperture?: number;
|
|
1649
|
+
base?: Array<number>;
|
|
1650
|
+
baseHandle?: string;
|
|
1651
|
+
copy?: boolean;
|
|
1652
|
+
factor?: number;
|
|
1653
|
+
handles?: Array<string>; /** a position counted from 0 (the first is 0) */
|
|
1654
|
+
index?: number; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1655
|
+
pick?: Array<number>;
|
|
1656
|
+
to?: Array<number>;
|
|
1657
|
+
};
|
|
1658
|
+
/** Grip Mirror. Mirrors the given objects about the line from a base point or grip to a second point, optionally copying them. Params: {handles?, base?: [x,y], baseHandle?, index?, to (second mirror point), copy?: bool} (the first mirror point: base, or baseHandle with index). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1659
|
+
"grip.mirror": {
|
|
1660
|
+
aperture?: number;
|
|
1661
|
+
base?: Array<number>;
|
|
1662
|
+
baseHandle?: string;
|
|
1663
|
+
copy?: boolean;
|
|
1664
|
+
handles?: Array<string>; /** a position counted from 0 (the first is 0) */
|
|
1665
|
+
index?: number; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1666
|
+
pick?: Array<number>;
|
|
1667
|
+
to?: Array<number>;
|
|
1668
|
+
};
|
|
1669
|
+
/** Layers. Answers every layer with its properties, whether it is current and in use, and the saved layer states, as the Layer Properties Manager shows. Params: {} ? layers, states (typed -LAYER: option prompts). Reads the active. Changes the document. */
|
|
1670
|
+
"layer": Record<string, never>;
|
|
1671
|
+
/** New Layer. Creates a layer with a name and optional colour, linetype and lineweight, optionally making it current. Params: {name, color?, linetype?, lineweight? (mm), current?: bool}. Changes the document. */
|
|
1672
|
+
"layer.new": {
|
|
1673
|
+
color?: string;
|
|
1674
|
+
current?: boolean;
|
|
1675
|
+
linetype?: string;
|
|
1676
|
+
lineweight?: Json;
|
|
1677
|
+
name?: string;
|
|
1678
|
+
};
|
|
1679
|
+
/** Set Layer Properties. Changes a layer's properties: on, frozen, locked, plot, colour, linetype, lineweight, transparency, description, plot style, or name. Params: {name, on?, frozen?, locked?, plot?, color?, linetype?, lineweight?, transparency?, description?, newVpFreeze?, plotStyle? (named plot style), newName?}. Reads the active. Changes the document. */
|
|
1680
|
+
"layer.set": {
|
|
1681
|
+
color?: string;
|
|
1682
|
+
description?: string;
|
|
1683
|
+
frozen?: boolean;
|
|
1684
|
+
linetype?: string;
|
|
1685
|
+
lineweight?: Json;
|
|
1686
|
+
locked?: boolean;
|
|
1687
|
+
name?: string;
|
|
1688
|
+
newName?: string;
|
|
1689
|
+
newVpFreeze?: boolean;
|
|
1690
|
+
on?: boolean;
|
|
1691
|
+
plot?: boolean;
|
|
1692
|
+
plotStyle?: string;
|
|
1693
|
+
transparency?: Json;
|
|
1694
|
+
};
|
|
1695
|
+
/** Make Current. Makes the named layer current, so new objects are drawn on it. Params: {name}. Changes the document. */
|
|
1696
|
+
"layer.current": {
|
|
1697
|
+
name?: string;
|
|
1698
|
+
};
|
|
1699
|
+
/** Delete Layer. Deletes the named layer when it is empty and is not layer 0, Defpoints or the current layer. Params: {name}. Reads the active. Changes the document. */
|
|
1700
|
+
"layer.delete": {
|
|
1701
|
+
name?: string;
|
|
1702
|
+
};
|
|
1703
|
+
/** Make Object's Layer Current. Makes the layer of the given object, or the selected one, the current layer. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1704
|
+
"laymcur": {
|
|
1705
|
+
aperture?: number;
|
|
1706
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1707
|
+
pick?: Array<number>;
|
|
1708
|
+
};
|
|
1709
|
+
/** Layer Match. Moves the given objects, or the selection, onto the named layer. Params: {handles?, layer: string (the target layer's name)}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1710
|
+
"laymch": {
|
|
1711
|
+
aperture?: number;
|
|
1712
|
+
handles?: Array<string>; /** the target layer's name */
|
|
1713
|
+
layer?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1714
|
+
pick?: Array<number>;
|
|
1715
|
+
};
|
|
1716
|
+
/** Change to Current Layer. Moves the given objects, or the selection, onto the current layer. Params: {handles?}. Acts on `handles`. Reads the active, selection. Changes the document. */
|
|
1717
|
+
"laycur": {
|
|
1718
|
+
aperture?: number;
|
|
1719
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1720
|
+
pick?: Array<number>;
|
|
1721
|
+
};
|
|
1722
|
+
/** Isolate Layer. Isolates the layers of the given objects, or the selection, by turning every other layer off. Params: {handles?}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1723
|
+
"layiso": {
|
|
1724
|
+
aperture?: number;
|
|
1725
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1726
|
+
pick?: Array<number>;
|
|
1727
|
+
};
|
|
1728
|
+
/** Unisolate Layer. Restores the layers turned off by the last layer isolate. Changes the document. */
|
|
1729
|
+
"layuniso": Record<string, never>;
|
|
1730
|
+
/** Freeze Layer. Freezes the layers of the given objects, or the selection. Params: {handles?}. Acts on `handles`. Reads the active, selection. Changes the document. */
|
|
1731
|
+
"layfrz": {
|
|
1732
|
+
aperture?: number;
|
|
1733
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1734
|
+
pick?: Array<number>;
|
|
1735
|
+
};
|
|
1736
|
+
/** Layer Off. Turns off the layers of the given objects, or the selection. Params: {handles?}. Acts on `handles`. Reads the active, selection. Changes the document. */
|
|
1737
|
+
"layoff": {
|
|
1738
|
+
aperture?: number;
|
|
1739
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1740
|
+
pick?: Array<number>;
|
|
1741
|
+
};
|
|
1742
|
+
/** Lock Layer. Locks the layers of the given objects, or the selection, so their objects cannot be edited. Params: {handles?}. Acts on `handles`. Reads the active, selection. Changes the document. */
|
|
1743
|
+
"laylck": {
|
|
1744
|
+
aperture?: number;
|
|
1745
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1746
|
+
pick?: Array<number>;
|
|
1747
|
+
};
|
|
1748
|
+
/** Unlock Layer. Unlocks the layers of the given objects, or the selection. Params: {handles?}. Acts on `handles`. Reads the active, selection. Changes the document. */
|
|
1749
|
+
"layulk": {
|
|
1750
|
+
aperture?: number;
|
|
1751
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1752
|
+
pick?: Array<number>;
|
|
1753
|
+
};
|
|
1754
|
+
/** Turn All Layers On. Turns every layer in the drawing on. Changes the document. */
|
|
1755
|
+
"layon": Record<string, never>;
|
|
1756
|
+
/** Thaw All Layers. Thaws every frozen layer in the drawing. Changes the document. */
|
|
1757
|
+
"laythw": Record<string, never>;
|
|
1758
|
+
/** Previous Layer. Undoes the last change to layer settings, restoring the previous layer state. Changes the document. */
|
|
1759
|
+
"layerp": Record<string, never>;
|
|
1760
|
+
/** Save Layer State. Saves every layer's current settings as a named layer state. Params: {name}. Changes the document. */
|
|
1761
|
+
"layerstate.save": {
|
|
1762
|
+
name?: string;
|
|
1763
|
+
};
|
|
1764
|
+
/** Restore Layer State. Restores the layer settings saved in the named layer state. Params: {name}. Changes the document. */
|
|
1765
|
+
"layerstate.restore": {
|
|
1766
|
+
name?: string;
|
|
1767
|
+
};
|
|
1768
|
+
/** List Layer States. Answers the names of the saved layer states, with a message line. Params: {} ? states. */
|
|
1769
|
+
"layerstate.list": Record<string, never>;
|
|
1770
|
+
/** Delete Layer State. Deletes the named saved layer state. Params: {name}. Changes the document. */
|
|
1771
|
+
"layerstate.delete": {
|
|
1772
|
+
name?: string;
|
|
1773
|
+
};
|
|
1774
|
+
/** Rename Layer State. Renames a saved layer state from one name to another. Params: {from, to}. Changes the document. */
|
|
1775
|
+
"layerstate.rename": {
|
|
1776
|
+
from?: string;
|
|
1777
|
+
to?: string;
|
|
1778
|
+
};
|
|
1779
|
+
/** Layer Merge. Moves the objects on the from layers onto a target layer, then deletes the from layers. Params: {from: [names], to} (the from layers' objects move to `to`, then the from layers are deleted). Reads the active. Changes the document. */
|
|
1780
|
+
"laymrg": {
|
|
1781
|
+
from?: Array<Json>;
|
|
1782
|
+
to?: string;
|
|
1783
|
+
};
|
|
1784
|
+
/** Layer Delete. Deletes the named layers together with every object on them. Params: {names: [...]} (deletes the layers and every object on them). Reads the active. Changes the document. */
|
|
1785
|
+
"laydel": {
|
|
1786
|
+
names?: Array<Json>;
|
|
1787
|
+
};
|
|
1788
|
+
/** Layout. Creates, copies, deletes, renames, sets or lists paper space layouts, with the option prompts of LAYOUT. Params: {option: new|copy|delete|rename|set|list, name?, to?} (typed LAYOUT / -LAYOUT: option prompts). Reads the active, part. Changes the document. */
|
|
1789
|
+
"layout": {
|
|
1790
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1791
|
+
layout?: string;
|
|
1792
|
+
name?: string;
|
|
1793
|
+
option?: "new" | "copy" | "delete" | "rename" | "set" | "list";
|
|
1794
|
+
to?: string;
|
|
1795
|
+
};
|
|
1796
|
+
/** New Layout. Creates a paper space layout with a name, by default with one viewport, and answers its name and viewport. Params: {name?, viewport?: bool (default true)} ? {name, viewport}. Reads the active. Changes the document. */
|
|
1797
|
+
"layout.new": {
|
|
1798
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
1799
|
+
layout?: string;
|
|
1800
|
+
name?: string; /** default true */
|
|
1801
|
+
viewport?: boolean;
|
|
1802
|
+
};
|
|
1803
|
+
/** Delete Layout. Deletes the named paper space layout. Params: {name}. Reads the part. Changes the document. */
|
|
1804
|
+
"layout.delete": {
|
|
1805
|
+
name?: string;
|
|
1806
|
+
};
|
|
1807
|
+
/** Rename Layout. Renames a layout, by default the current one, to a new name. Params: {from?: current layout, to}. Reads the part. Changes the document. */
|
|
1808
|
+
"layout.rename": {
|
|
1809
|
+
from?: string;
|
|
1810
|
+
to?: string;
|
|
1811
|
+
};
|
|
1812
|
+
/** Copy Layout. Copies a layout with its page setup and viewports to a new layout name. Params: {from, to?}. Changes the document. */
|
|
1813
|
+
"layout.copy": {
|
|
1814
|
+
from?: string;
|
|
1815
|
+
to?: string;
|
|
1816
|
+
};
|
|
1817
|
+
/** List Layouts. Answers every layout with its name, tab order, whether it is current, its page setup and its viewports. Params: {} ? [{name, tabOrder, page, viewports}]. Reads the part. */
|
|
1818
|
+
"layout.list": Record<string, never>;
|
|
1819
|
+
/** Viewports. Creates one to four viewports in a layout over two corners, by default the printable area, in an arrangement. Params: {p1?, p2? (default: printable area), count?: 1-4, arrangement?: vertical|horizontal|left|right|above|below, layout?}. Reads the active, part. Changes the document. */
|
|
1820
|
+
"mview": {
|
|
1821
|
+
arrangement?: "vertical" | "horizontal" | "left" | "right" | "above" | "below";
|
|
1822
|
+
count?: number;
|
|
1823
|
+
layout?: string;
|
|
1824
|
+
p1?: Array<number>;
|
|
1825
|
+
p2?: Array<number>;
|
|
1826
|
+
};
|
|
1827
|
+
/** New Viewports... Creates one to four viewports on a layout in an arrangement, over two corners or the printable area. Params: {count?: 1-4, arrangement?, p1?, p2?, layout?}. Reads the active, part. Changes the document. */
|
|
1828
|
+
"vports": {
|
|
1829
|
+
arrangement?: string;
|
|
1830
|
+
count?: number;
|
|
1831
|
+
layout?: string;
|
|
1832
|
+
p1?: Array<number>;
|
|
1833
|
+
p2?: Array<number>;
|
|
1834
|
+
};
|
|
1835
|
+
/** 1 Viewport. Creates a single viewport on a layout over two corners, by default the printable area. Params: {p1?, p2?, layout?}. Reads the active, part. Changes the document. */
|
|
1836
|
+
"vports.1": {
|
|
1837
|
+
layout?: string;
|
|
1838
|
+
p1?: Array<number>;
|
|
1839
|
+
p2?: Array<number>;
|
|
1840
|
+
};
|
|
1841
|
+
/** 2 Viewports. Creates two viewports on a layout side by side or stacked, over two corners or the printable area. Params: {p1?, p2?, arrangement?: vertical|horizontal, layout?}. Reads the active, part. Changes the document. */
|
|
1842
|
+
"vports.2": {
|
|
1843
|
+
arrangement?: "vertical" | "horizontal";
|
|
1844
|
+
layout?: string;
|
|
1845
|
+
p1?: Array<number>;
|
|
1846
|
+
p2?: Array<number>;
|
|
1847
|
+
};
|
|
1848
|
+
/** 3 Viewports. Creates three viewports on a layout with the large one right, left, above or below, or in a row or column. Params: {p1?, p2?, arrangement?: right|left|above|below|vertical|horizontal, layout?}. Reads the active, part. Changes the document. */
|
|
1849
|
+
"vports.3": {
|
|
1850
|
+
arrangement?: "right" | "left" | "above" | "below" | "vertical" | "horizontal";
|
|
1851
|
+
layout?: string;
|
|
1852
|
+
p1?: Array<number>;
|
|
1853
|
+
p2?: Array<number>;
|
|
1854
|
+
};
|
|
1855
|
+
/** 4 Viewports. Creates four equal viewports on a layout over two corners, by default the printable area. Params: {p1?, p2?, layout?}. Reads the active, part. Changes the document. */
|
|
1856
|
+
"vports.4": {
|
|
1857
|
+
layout?: string;
|
|
1858
|
+
p1?: Array<number>;
|
|
1859
|
+
p2?: Array<number>;
|
|
1860
|
+
};
|
|
1861
|
+
/** Viewport Properties. Sets layout viewport properties: scale, view height and centre, lock, layer freeze and thaw, and per-layer colour overrides. Params: {handle? (default: selected viewports), handles?, scale?: paper units per model unit | "1:50", viewHeight?, center?: [x,y], locked?, freeze?: [layer], thaw?: [layer], colors?: {layer: color | null}}. Acts on `handles`. Reads the part, selection. Changes the document. */
|
|
1862
|
+
"viewport.set": {
|
|
1863
|
+
aperture?: number;
|
|
1864
|
+
center?: Array<number>; /** {layer: color | null} */
|
|
1865
|
+
colors?: {
|
|
1866
|
+
layer?: Json;
|
|
1867
|
+
}; /** [layer] */
|
|
1868
|
+
freeze?: Array<Json>;
|
|
1869
|
+
handle?: string;
|
|
1870
|
+
handles?: Array<string>;
|
|
1871
|
+
locked?: boolean; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1872
|
+
pick?: Array<number>;
|
|
1873
|
+
scale?: Json; /** [layer] */
|
|
1874
|
+
thaw?: Array<Json>;
|
|
1875
|
+
viewHeight?: number;
|
|
1876
|
+
};
|
|
1877
|
+
/** Viewport Layer Freeze. Freezes or thaws layers and overrides layer colours in one layout viewport only. Params: {handle?, handles?, scale?: paper units per model unit | "1:50", viewHeight?, center?: [x,y], locked?: bool, freeze?: [layer], thaw?: [layer], colors?: {layer: color ("red" | 1..255 | "r,g,b") | null to clear}} (typed: option prompts). Acts on `handles`. Reads the part, selection. Changes the document. */
|
|
1878
|
+
"vplayer": {
|
|
1879
|
+
aperture?: number;
|
|
1880
|
+
center?: Array<number>; /** {layer: color ("red" | 1..255 | "r,g,b") | null to clear}; "red" | 1..255 | "r,g,b" */
|
|
1881
|
+
colors?: {
|
|
1882
|
+
layer?: Json;
|
|
1883
|
+
}; /** [layer] */
|
|
1884
|
+
freeze?: Array<Json>;
|
|
1885
|
+
handle?: string;
|
|
1886
|
+
handles?: Array<string>;
|
|
1887
|
+
locked?: boolean; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1888
|
+
pick?: Array<number>;
|
|
1889
|
+
scale?: Json; /** [layer] */
|
|
1890
|
+
thaw?: Array<Json>;
|
|
1891
|
+
viewHeight?: number;
|
|
1892
|
+
};
|
|
1893
|
+
/** Page Setup Manager... Sets a layout's page setup: paper, orientation, margins, plot area, scale or fit, centring, lineweights and plot style table. Params: {layout?: current, paper?: "A4"|"A3"|"Letter"|"ANSI B"|..., width?, height? (mm), landscape?, margins?: [l,b,r,t] mm, lineweights?, plotArea?, scale?, scaleToFit?, center?, plotStyleTable?: "monochrome.ctb"|"grayscale.ctb"|"default.ctb"|"None"|..., displayPlotStyles?: bool}. Reads the part. Changes the document. */
|
|
1894
|
+
"pagesetup": {
|
|
1895
|
+
center?: boolean;
|
|
1896
|
+
displayPlotStyles?: boolean; /** mm */
|
|
1897
|
+
height?: number;
|
|
1898
|
+
landscape?: boolean;
|
|
1899
|
+
layout?: string;
|
|
1900
|
+
lineweights?: boolean;
|
|
1901
|
+
margins?: Array<number>;
|
|
1902
|
+
paper?: string;
|
|
1903
|
+
plotArea?: string;
|
|
1904
|
+
plotStyleTable?: string;
|
|
1905
|
+
scale?: number;
|
|
1906
|
+
scaleToFit?: boolean;
|
|
1907
|
+
width?: number;
|
|
1908
|
+
};
|
|
1909
|
+
/** Print... Plots a layout or model space to PDF, on a paper and orientation, at a scale or fitted, written to a path or answered as base64. Params: {path? (else returns base64 `data`), layout?: current|"Model", paper?, landscape?, fit?: bool, scale?, lineweights?: bool}. Reads the part. */
|
|
1910
|
+
"plot": {
|
|
1911
|
+
fit?: boolean;
|
|
1912
|
+
landscape?: boolean;
|
|
1913
|
+
layout?: string;
|
|
1914
|
+
lineweights?: boolean;
|
|
1915
|
+
paper?: string; /** else returns base64 `data` */
|
|
1916
|
+
path?: Json;
|
|
1917
|
+
scale?: number;
|
|
1918
|
+
};
|
|
1919
|
+
/** Export to PDF... Exports a layout or model space to PDF, on a paper and orientation, fitted or not, to a path or answered as base64. Params: {path? (else returns base64 `data`), layout?, paper?, landscape?, fit?, lineweights?}. Reads the part. */
|
|
1920
|
+
"exportpdf": {
|
|
1921
|
+
fit?: boolean;
|
|
1922
|
+
landscape?: boolean;
|
|
1923
|
+
layout?: string;
|
|
1924
|
+
lineweights?: boolean;
|
|
1925
|
+
paper?: string; /** else returns base64 `data` */
|
|
1926
|
+
path?: Json;
|
|
1927
|
+
};
|
|
1928
|
+
/** Model Space (in viewport). Makes a layout viewport active so editing happens in model space through it, by handle or by a paper point inside it. Params: {handle?: viewport, at?: [x,y] paper point inside a viewport} (default: the last active or first viewport). Reads the part. */
|
|
1929
|
+
"mspace": {
|
|
1930
|
+
at?: Array<number>;
|
|
1931
|
+
handle?: string;
|
|
1932
|
+
};
|
|
1933
|
+
/** Paper Space. Leaves the active viewport so editing happens in the layout's paper space again. Reads the part. */
|
|
1934
|
+
"pspace": Record<string, never>;
|
|
1935
|
+
/** Plot Style... Sets the named plot style of the given or selected objects, or the current one for new objects; with no name reports it. Params: {name?: "ByLayer"|"ByBlock"|style name, handles?|handle? (default: the selection; nothing selected sets the current plot style for new objects, CPLOTSTYLE)} (no name: reports the current style and the named styles). Acts on `handles`. Reads the selection. Changes the document. */
|
|
1936
|
+
"plotstyle": {
|
|
1937
|
+
aperture?: number;
|
|
1938
|
+
handle?: string;
|
|
1939
|
+
handles?: Array<string>;
|
|
1940
|
+
name?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1941
|
+
pick?: Array<number>;
|
|
1942
|
+
};
|
|
1943
|
+
/** Plot Style Manager... Lists, reads, creates, changes, deletes, loads or saves plot style tables (colour-dependent .ctb or named .stb) and their styles. Params: {action?: list (default)|get|new|set|delete|load|save, name?: table ("x.ctb"/"x.stb"), kind?: colorDependent|named (new), from?: table to copy (new), description?, style?: {name, color?: "#rrggbb"|null, grayscale?, screening?: 0-100, linetype?: name|null, lineweight?: mm|null, end?, join?, fill?, description?} (set), removeStyle?: name (set, named tables), path? (load/save; save without one returns `text`), text? (load)}. Changes the document. */
|
|
1944
|
+
"stylesmanager": {
|
|
1945
|
+
action?: "list" | "get" | "new" | "set" | "delete" | "load" | "save";
|
|
1946
|
+
description?: string;
|
|
1947
|
+
from?: string; /** new */
|
|
1948
|
+
kind?: "colorDependent" | "named";
|
|
1949
|
+
name?: string; /** load/save; save without one returns `text` */
|
|
1950
|
+
path?: Json; /** set, named tables */
|
|
1951
|
+
removeStyle?: string; /** {name, color?: "#rrggbb"|null, grayscale?, screening?: 0-100, linetype?: name|null, lineweight?: mm|null, end?, join?, fill?, description?} (set); set */
|
|
1952
|
+
style?: {
|
|
1953
|
+
color?: Json;
|
|
1954
|
+
description?: Json;
|
|
1955
|
+
end?: number;
|
|
1956
|
+
fill?: Json;
|
|
1957
|
+
grayscale?: Json;
|
|
1958
|
+
join?: Json;
|
|
1959
|
+
linetype?: Json;
|
|
1960
|
+
lineweight?: Json;
|
|
1961
|
+
name?: string;
|
|
1962
|
+
screening?: Json;
|
|
1963
|
+
}; /** load */
|
|
1964
|
+
text?: string;
|
|
1965
|
+
};
|
|
1966
|
+
/** Properties. Answers the properties of the given objects, or the selection: type, handle, layer, colour, linetype, bounds and geometry. Params: {handles?} ? properties of the selection. Acts on `handles`. Reads the active, selection. */
|
|
1967
|
+
"properties": {
|
|
1968
|
+
aperture?: number;
|
|
1969
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1970
|
+
pick?: Array<number>;
|
|
1971
|
+
};
|
|
1972
|
+
/** Set Properties. Sets properties of the given objects, or the selection: layer, colour, linetype, lineweight, scale, transparency, visibility and geometry fields. Params: {handles?, layer?: string (a layer name), color?, linetype?, lineweight?, ltscale?: number, transparency?: "ByLayer" | "ByBlock" | 0..90, visible?: bool, dimStyle?: string (a dimension style name), start?: [x,y], end?: [x,y], length?: number (a line's), angle?: number (degrees; a line's, or a hatch pattern's), center?: [x,y], radius?: number, diameter?: number, circumference?: number, area?: number, startAngle?: number (degrees), endAngle?: number (degrees), text?: string, textOverride?: string (a dimension's), height?: number, rotation?: number (degrees), widthFactor?: number, width?: number (a polyline's or text frame's), position?: [x,y] (text), closed?: bool, scale?: number (a block's or hatch pattern's), pattern?: string (a hatch pattern name)}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
1973
|
+
"properties.set": {
|
|
1974
|
+
angle?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
1975
|
+
aperture?: number;
|
|
1976
|
+
area?: number;
|
|
1977
|
+
center?: Array<number>;
|
|
1978
|
+
circumference?: number;
|
|
1979
|
+
closed?: boolean;
|
|
1980
|
+
color?: string;
|
|
1981
|
+
diameter?: number; /** a dimension style name */
|
|
1982
|
+
dimStyle?: string;
|
|
1983
|
+
end?: Array<number>; /** degrees */
|
|
1984
|
+
endAngle?: number;
|
|
1985
|
+
handles?: Array<string>;
|
|
1986
|
+
height?: number; /** a layer name */
|
|
1987
|
+
layer?: string; /** a line's */
|
|
1988
|
+
length?: number;
|
|
1989
|
+
linetype?: string;
|
|
1990
|
+
lineweight?: Json;
|
|
1991
|
+
ltscale?: number; /** a hatch pattern name */
|
|
1992
|
+
pattern?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
1993
|
+
pick?: Array<number>; /** text */
|
|
1994
|
+
position?: Array<number>;
|
|
1995
|
+
radius?: number; /** degrees */
|
|
1996
|
+
rotation?: number; /** a block's or hatch pattern's */
|
|
1997
|
+
scale?: number;
|
|
1998
|
+
start?: Array<number>; /** degrees */
|
|
1999
|
+
startAngle?: number;
|
|
2000
|
+
text?: string; /** a dimension's */
|
|
2001
|
+
textOverride?: string;
|
|
2002
|
+
transparency?: Json;
|
|
2003
|
+
visible?: boolean; /** a polyline's or text frame's */
|
|
2004
|
+
width?: number;
|
|
2005
|
+
widthFactor?: number;
|
|
2006
|
+
};
|
|
2007
|
+
/** Match Properties. Copies the layer, colour, linetype, lineweight and other properties of a source object onto the target objects. Params: {source, targets: [str] (handles)}. Changes the document. */
|
|
2008
|
+
"matchprop": {
|
|
2009
|
+
source?: string; /** handles */
|
|
2010
|
+
targets?: Array<string>;
|
|
2011
|
+
};
|
|
2012
|
+
/** Color... Sets the current colour for new objects: ByLayer, ByBlock, a colour name, an index 1 to 255 or an r,g,b triple. Params: {color: "ByLayer" | "red" | 1..255 | "r,g,b"}. Changes the document. */
|
|
2013
|
+
"color": {
|
|
2014
|
+
color?: Json;
|
|
2015
|
+
};
|
|
2016
|
+
/** Linetype... Loads a linetype, or every one, from the built-in definitions, or sets the current linetype for new objects. Params: {current?: name, load?: name | "*"}. Changes the document. */
|
|
2017
|
+
"linetype": {
|
|
2018
|
+
current?: string;
|
|
2019
|
+
load?: string;
|
|
2020
|
+
};
|
|
2021
|
+
/** Lineweight... Sets the current lineweight for new objects, in millimetres or ByLayer. Params: {lineweight: mm | ByLayer}. Changes the document. */
|
|
2022
|
+
"lweight": {
|
|
2023
|
+
lineweight?: "mm" | "ByLayer";
|
|
2024
|
+
};
|
|
2025
|
+
/** Linetype Scale. Sets the drawing's global linetype scale factor (LTSCALE). Params: {scale}. Changes the document. */
|
|
2026
|
+
"ltscale": {
|
|
2027
|
+
scale?: number;
|
|
2028
|
+
};
|
|
2029
|
+
/** Units... Sets the drawing's length and angle unit formats and precisions, and its insertion units. Params: {lunits?: 1..5, luprec?: 0..8, aunits?: 0..4, auprec?: 0..8, insunits?}. Changes the document. */
|
|
2030
|
+
"units": {
|
|
2031
|
+
aunits?: number; /** 0 to 8 */
|
|
2032
|
+
auprec?: number;
|
|
2033
|
+
insunits?: number; /** 1 to 5 */
|
|
2034
|
+
lunits?: number; /** 0 to 8 */
|
|
2035
|
+
luprec?: number;
|
|
2036
|
+
};
|
|
2037
|
+
/** Drawing Limits. Sets the drawing limits of model space from a lower-left and an upper-right corner. Params: {min: [x,y], max: [x,y]}. Changes the document. */
|
|
2038
|
+
"limits": {
|
|
2039
|
+
max?: Array<number>;
|
|
2040
|
+
min?: Array<number>;
|
|
2041
|
+
};
|
|
2042
|
+
/** Text Style... Creates or changes a text style: font, big font, height, width factor, oblique angle, flags, annotative, and optionally makes it current. Params: {name, font?, bigFont?, height?, widthFactor?, oblique? (degrees), backwards?, upsideDown?, vertical?, annotative?, current?} ? styles. Reads the active. Changes the document. */
|
|
2043
|
+
"style": {
|
|
2044
|
+
annotative?: boolean;
|
|
2045
|
+
backwards?: boolean;
|
|
2046
|
+
bigFont?: string;
|
|
2047
|
+
current?: boolean;
|
|
2048
|
+
font?: string;
|
|
2049
|
+
height?: number;
|
|
2050
|
+
name?: string;
|
|
2051
|
+
oblique?: number;
|
|
2052
|
+
upsideDown?: boolean;
|
|
2053
|
+
vertical?: boolean;
|
|
2054
|
+
widthFactor?: number;
|
|
2055
|
+
};
|
|
2056
|
+
/** List Text Styles. Answers every text style with its font, height, width factor, flags and whether it is current. Params: {} ? text styles. Reads the active. */
|
|
2057
|
+
"style.list": Record<string, never>;
|
|
2058
|
+
/** Rename Text Style. Renames a text style from one name to another. Params: {from, to}. Reads the active. Changes the document. */
|
|
2059
|
+
"style.rename": {
|
|
2060
|
+
from?: string;
|
|
2061
|
+
to?: string;
|
|
2062
|
+
};
|
|
2063
|
+
/** Delete Text Style. Deletes a text style that is not Standard, current or used by any object. Params: {name} (not Standard, the current style or one in use). Reads the active. Changes the document. */
|
|
2064
|
+
"style.delete": {
|
|
2065
|
+
name?: string;
|
|
2066
|
+
};
|
|
2067
|
+
/** Set Current Text Style. Makes the named text style the current one for new text. Params: {name}. Changes the document. */
|
|
2068
|
+
"style.current": {
|
|
2069
|
+
name?: string;
|
|
2070
|
+
};
|
|
2071
|
+
/** Dimension Style... Creates or changes a dimension style from style fields or DIM variables, and by default makes it current; answers the styles. Params: {name: str, current?: bool (make it the current style; default true), <style fields or DIM* variables, e.g. arrowSize / DIMASZ, DIMTSZ, DIMBLK, DIMTAD, DIMLUNIT...>} ? styles. Reads the active. Changes the document. */
|
|
2072
|
+
"dimstyle": {
|
|
2073
|
+
DIMADEC?: Json;
|
|
2074
|
+
DIMALT?: Json;
|
|
2075
|
+
DIMALTD?: Json;
|
|
2076
|
+
DIMALTF?: Json;
|
|
2077
|
+
DIMALTRND?: Json;
|
|
2078
|
+
DIMALTU?: Json;
|
|
2079
|
+
DIMALTZ?: Json;
|
|
2080
|
+
DIMAPOST?: Json;
|
|
2081
|
+
DIMASZ?: Json;
|
|
2082
|
+
DIMAUNIT?: Json;
|
|
2083
|
+
DIMBLK?: string;
|
|
2084
|
+
DIMBLK1?: Json;
|
|
2085
|
+
DIMBLK2?: Json;
|
|
2086
|
+
DIMCEN?: Json;
|
|
2087
|
+
DIMCLRD?: Json;
|
|
2088
|
+
DIMCLRE?: Json;
|
|
2089
|
+
DIMCLRT?: Json;
|
|
2090
|
+
DIMDEC?: Json;
|
|
2091
|
+
DIMDLE?: Json;
|
|
2092
|
+
DIMDLI?: Json;
|
|
2093
|
+
DIMDSEP?: Json;
|
|
2094
|
+
DIMEXE?: Json;
|
|
2095
|
+
DIMEXO?: Json;
|
|
2096
|
+
DIMFRAC?: Json;
|
|
2097
|
+
DIMGAP?: Json;
|
|
2098
|
+
DIMJUST?: Json;
|
|
2099
|
+
DIMLFAC?: Json;
|
|
2100
|
+
DIMLIM?: Json;
|
|
2101
|
+
DIMLUNIT?: Json;
|
|
2102
|
+
DIMPOST?: Json;
|
|
2103
|
+
DIMRND?: Json;
|
|
2104
|
+
DIMSCALE?: Json;
|
|
2105
|
+
DIMSE1?: Json;
|
|
2106
|
+
DIMSE2?: Json;
|
|
2107
|
+
DIMTAD?: number;
|
|
2108
|
+
DIMTDEC?: Json;
|
|
2109
|
+
DIMTFAC?: Json;
|
|
2110
|
+
DIMTIH?: Json;
|
|
2111
|
+
DIMTM?: Json;
|
|
2112
|
+
DIMTOH?: Json;
|
|
2113
|
+
DIMTOL?: Json;
|
|
2114
|
+
DIMTP?: Json;
|
|
2115
|
+
DIMTSZ?: number;
|
|
2116
|
+
DIMTXSTY?: Json;
|
|
2117
|
+
DIMTXT?: Json;
|
|
2118
|
+
DIMTZIN?: Json;
|
|
2119
|
+
DIMZIN?: Json;
|
|
2120
|
+
alt?: Json;
|
|
2121
|
+
altDecimals?: Json;
|
|
2122
|
+
altFactor?: Json;
|
|
2123
|
+
altPost?: Json;
|
|
2124
|
+
altRound?: Json;
|
|
2125
|
+
altUnit?: Json;
|
|
2126
|
+
altZeroSuppression?: Json;
|
|
2127
|
+
angularDecimals?: Json;
|
|
2128
|
+
angularUnit?: Json;
|
|
2129
|
+
annotative?: Json;
|
|
2130
|
+
arrowBlock?: Json;
|
|
2131
|
+
arrowBlock1?: Json;
|
|
2132
|
+
arrowBlock2?: Json;
|
|
2133
|
+
arrowSize?: Json;
|
|
2134
|
+
baselineSpacing?: Json;
|
|
2135
|
+
centerMark?: Json; /** make it the current style; default true */
|
|
2136
|
+
current?: boolean;
|
|
2137
|
+
decimalSeparator?: Json;
|
|
2138
|
+
decimals?: Json;
|
|
2139
|
+
dimLineColor?: Json;
|
|
2140
|
+
dimLineExtend?: Json;
|
|
2141
|
+
extExtend?: Json;
|
|
2142
|
+
extLineColor?: Json;
|
|
2143
|
+
extOffset?: Json;
|
|
2144
|
+
fractionFormat?: Json;
|
|
2145
|
+
limits?: Json;
|
|
2146
|
+
linearFactor?: Json;
|
|
2147
|
+
linearUnit?: Json;
|
|
2148
|
+
name?: string;
|
|
2149
|
+
post?: Json;
|
|
2150
|
+
round?: Json;
|
|
2151
|
+
scale?: Json;
|
|
2152
|
+
suppressExt1?: Json;
|
|
2153
|
+
suppressExt2?: Json;
|
|
2154
|
+
textAbove?: Json;
|
|
2155
|
+
textColor?: Json;
|
|
2156
|
+
textGap?: Json;
|
|
2157
|
+
textHeight?: Json;
|
|
2158
|
+
textInsideHorizontal?: Json;
|
|
2159
|
+
textJust?: Json;
|
|
2160
|
+
textOutsideHorizontal?: Json;
|
|
2161
|
+
textStyle?: Json;
|
|
2162
|
+
tickSize?: Json;
|
|
2163
|
+
tolDecimals?: Json;
|
|
2164
|
+
tolMinus?: Json;
|
|
2165
|
+
tolPlus?: Json;
|
|
2166
|
+
tolScale?: Json;
|
|
2167
|
+
tolZeroSuppression?: Json;
|
|
2168
|
+
tolerance?: Json;
|
|
2169
|
+
zeroSuppression?: Json;
|
|
2170
|
+
};
|
|
2171
|
+
/** Dimension Style... Creates or changes a dimension style from style fields or DIM variables, and by default makes it current, from the Dimension menu. Params: {name: str, current?: bool (make it the current style; default true), <style fields or DIM* variables, e.g. arrowSize / DIMASZ, DIMTSZ, DIMBLK, DIMTAD, DIMLUNIT...>} ? styles. Reads the active. Changes the document. */
|
|
2172
|
+
"dimstyle.dimension": {
|
|
2173
|
+
DIMADEC?: Json;
|
|
2174
|
+
DIMALT?: Json;
|
|
2175
|
+
DIMALTD?: Json;
|
|
2176
|
+
DIMALTF?: Json;
|
|
2177
|
+
DIMALTRND?: Json;
|
|
2178
|
+
DIMALTU?: Json;
|
|
2179
|
+
DIMALTZ?: Json;
|
|
2180
|
+
DIMAPOST?: Json;
|
|
2181
|
+
DIMASZ?: Json;
|
|
2182
|
+
DIMAUNIT?: Json;
|
|
2183
|
+
DIMBLK?: string;
|
|
2184
|
+
DIMBLK1?: Json;
|
|
2185
|
+
DIMBLK2?: Json;
|
|
2186
|
+
DIMCEN?: Json;
|
|
2187
|
+
DIMCLRD?: Json;
|
|
2188
|
+
DIMCLRE?: Json;
|
|
2189
|
+
DIMCLRT?: Json;
|
|
2190
|
+
DIMDEC?: Json;
|
|
2191
|
+
DIMDLE?: Json;
|
|
2192
|
+
DIMDLI?: Json;
|
|
2193
|
+
DIMDSEP?: Json;
|
|
2194
|
+
DIMEXE?: Json;
|
|
2195
|
+
DIMEXO?: Json;
|
|
2196
|
+
DIMFRAC?: Json;
|
|
2197
|
+
DIMGAP?: Json;
|
|
2198
|
+
DIMJUST?: Json;
|
|
2199
|
+
DIMLFAC?: Json;
|
|
2200
|
+
DIMLIM?: Json;
|
|
2201
|
+
DIMLUNIT?: Json;
|
|
2202
|
+
DIMPOST?: Json;
|
|
2203
|
+
DIMRND?: Json;
|
|
2204
|
+
DIMSCALE?: Json;
|
|
2205
|
+
DIMSE1?: Json;
|
|
2206
|
+
DIMSE2?: Json;
|
|
2207
|
+
DIMTAD?: number;
|
|
2208
|
+
DIMTDEC?: Json;
|
|
2209
|
+
DIMTFAC?: Json;
|
|
2210
|
+
DIMTIH?: Json;
|
|
2211
|
+
DIMTM?: Json;
|
|
2212
|
+
DIMTOH?: Json;
|
|
2213
|
+
DIMTOL?: Json;
|
|
2214
|
+
DIMTP?: Json;
|
|
2215
|
+
DIMTSZ?: number;
|
|
2216
|
+
DIMTXSTY?: Json;
|
|
2217
|
+
DIMTXT?: Json;
|
|
2218
|
+
DIMTZIN?: Json;
|
|
2219
|
+
DIMZIN?: Json;
|
|
2220
|
+
alt?: Json;
|
|
2221
|
+
altDecimals?: Json;
|
|
2222
|
+
altFactor?: Json;
|
|
2223
|
+
altPost?: Json;
|
|
2224
|
+
altRound?: Json;
|
|
2225
|
+
altUnit?: Json;
|
|
2226
|
+
altZeroSuppression?: Json;
|
|
2227
|
+
angularDecimals?: Json;
|
|
2228
|
+
angularUnit?: Json;
|
|
2229
|
+
annotative?: Json;
|
|
2230
|
+
arrowBlock?: Json;
|
|
2231
|
+
arrowBlock1?: Json;
|
|
2232
|
+
arrowBlock2?: Json;
|
|
2233
|
+
arrowSize?: Json;
|
|
2234
|
+
baselineSpacing?: Json;
|
|
2235
|
+
centerMark?: Json; /** make it the current style; default true */
|
|
2236
|
+
current?: boolean;
|
|
2237
|
+
decimalSeparator?: Json;
|
|
2238
|
+
decimals?: Json;
|
|
2239
|
+
dimLineColor?: Json;
|
|
2240
|
+
dimLineExtend?: Json;
|
|
2241
|
+
extExtend?: Json;
|
|
2242
|
+
extLineColor?: Json;
|
|
2243
|
+
extOffset?: Json;
|
|
2244
|
+
fractionFormat?: Json;
|
|
2245
|
+
limits?: Json;
|
|
2246
|
+
linearFactor?: Json;
|
|
2247
|
+
linearUnit?: Json;
|
|
2248
|
+
name?: string;
|
|
2249
|
+
post?: Json;
|
|
2250
|
+
round?: Json;
|
|
2251
|
+
scale?: Json;
|
|
2252
|
+
suppressExt1?: Json;
|
|
2253
|
+
suppressExt2?: Json;
|
|
2254
|
+
textAbove?: Json;
|
|
2255
|
+
textColor?: Json;
|
|
2256
|
+
textGap?: Json;
|
|
2257
|
+
textHeight?: Json;
|
|
2258
|
+
textInsideHorizontal?: Json;
|
|
2259
|
+
textJust?: Json;
|
|
2260
|
+
textOutsideHorizontal?: Json;
|
|
2261
|
+
textStyle?: Json;
|
|
2262
|
+
tickSize?: Json;
|
|
2263
|
+
tolDecimals?: Json;
|
|
2264
|
+
tolMinus?: Json;
|
|
2265
|
+
tolPlus?: Json;
|
|
2266
|
+
tolScale?: Json;
|
|
2267
|
+
tolZeroSuppression?: Json;
|
|
2268
|
+
tolerance?: Json;
|
|
2269
|
+
zeroSuppression?: Json;
|
|
2270
|
+
};
|
|
2271
|
+
/** List Dimension Styles. Answers the dimension styles and the current one, and every variable of the named style when one is given. Params: {name?} ? styles (with all variables for `name`). Reads the active. */
|
|
2272
|
+
"dimstyle.list": {
|
|
2273
|
+
name?: string;
|
|
2274
|
+
};
|
|
2275
|
+
/** Rename Dimension Style. Renames a dimension style from one name to another. Params: {from, to}. Reads the active. Changes the document. */
|
|
2276
|
+
"dimstyle.rename": {
|
|
2277
|
+
from?: string;
|
|
2278
|
+
to?: string;
|
|
2279
|
+
};
|
|
2280
|
+
/** Delete Dimension Style. Deletes a dimension style that is not Standard, current or used by any dimension. Params: {name} (not Standard, the current style or one in use). Reads the active. Changes the document. */
|
|
2281
|
+
"dimstyle.delete": {
|
|
2282
|
+
name?: string;
|
|
2283
|
+
};
|
|
2284
|
+
/** Set Current Dimension Style. Makes the named dimension style the current one for new dimensions. Params: {name}. Reads the active. Changes the document. */
|
|
2285
|
+
"dimstyle.current": {
|
|
2286
|
+
name?: string;
|
|
2287
|
+
};
|
|
2288
|
+
/** Dimension Style Override. Sets per-dimension overrides of style fields or DIM variables on the given dimensions, or clears them. Params: {handles?, <style fields or DIM* variables: values>, clear?: bool} (per-dimension overrides). Acts on `handles`. Reads the selection. Changes the document. */
|
|
2289
|
+
"dimstyle.override": {
|
|
2290
|
+
DIMADEC?: Json;
|
|
2291
|
+
DIMALT?: Json;
|
|
2292
|
+
DIMALTD?: Json;
|
|
2293
|
+
DIMALTF?: Json;
|
|
2294
|
+
DIMALTRND?: Json;
|
|
2295
|
+
DIMALTU?: Json;
|
|
2296
|
+
DIMALTZ?: Json;
|
|
2297
|
+
DIMAPOST?: Json;
|
|
2298
|
+
DIMASZ?: Json;
|
|
2299
|
+
DIMAUNIT?: Json;
|
|
2300
|
+
DIMBLK?: Json;
|
|
2301
|
+
DIMBLK1?: Json;
|
|
2302
|
+
DIMBLK2?: Json;
|
|
2303
|
+
DIMCEN?: Json;
|
|
2304
|
+
DIMCLRD?: Json;
|
|
2305
|
+
DIMCLRE?: Json;
|
|
2306
|
+
DIMCLRT?: Json;
|
|
2307
|
+
DIMDEC?: Json;
|
|
2308
|
+
DIMDLE?: Json;
|
|
2309
|
+
DIMDLI?: Json;
|
|
2310
|
+
DIMDSEP?: Json;
|
|
2311
|
+
DIMEXE?: Json;
|
|
2312
|
+
DIMEXO?: Json;
|
|
2313
|
+
DIMFRAC?: Json;
|
|
2314
|
+
DIMGAP?: Json;
|
|
2315
|
+
DIMJUST?: Json;
|
|
2316
|
+
DIMLFAC?: Json;
|
|
2317
|
+
DIMLIM?: Json;
|
|
2318
|
+
DIMLUNIT?: Json;
|
|
2319
|
+
DIMPOST?: Json;
|
|
2320
|
+
DIMRND?: Json;
|
|
2321
|
+
DIMSCALE?: Json;
|
|
2322
|
+
DIMSE1?: Json;
|
|
2323
|
+
DIMSE2?: Json;
|
|
2324
|
+
DIMTAD?: Json;
|
|
2325
|
+
DIMTDEC?: Json;
|
|
2326
|
+
DIMTFAC?: Json;
|
|
2327
|
+
DIMTIH?: Json;
|
|
2328
|
+
DIMTM?: Json;
|
|
2329
|
+
DIMTOH?: Json;
|
|
2330
|
+
DIMTOL?: Json;
|
|
2331
|
+
DIMTP?: Json;
|
|
2332
|
+
DIMTSZ?: Json;
|
|
2333
|
+
DIMTXSTY?: Json;
|
|
2334
|
+
DIMTXT?: Json;
|
|
2335
|
+
DIMTZIN?: Json;
|
|
2336
|
+
DIMZIN?: Json;
|
|
2337
|
+
alt?: Json;
|
|
2338
|
+
altDecimals?: Json;
|
|
2339
|
+
altFactor?: Json;
|
|
2340
|
+
altPost?: Json;
|
|
2341
|
+
altRound?: Json;
|
|
2342
|
+
altUnit?: Json;
|
|
2343
|
+
altZeroSuppression?: Json;
|
|
2344
|
+
angularDecimals?: Json;
|
|
2345
|
+
angularUnit?: Json;
|
|
2346
|
+
annotative?: Json; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
2347
|
+
aperture?: number;
|
|
2348
|
+
arrowBlock?: Json;
|
|
2349
|
+
arrowBlock1?: Json;
|
|
2350
|
+
arrowBlock2?: Json;
|
|
2351
|
+
arrowSize?: Json;
|
|
2352
|
+
baselineSpacing?: Json;
|
|
2353
|
+
centerMark?: Json;
|
|
2354
|
+
clear?: boolean;
|
|
2355
|
+
decimalSeparator?: Json;
|
|
2356
|
+
decimals?: Json;
|
|
2357
|
+
dimLineColor?: Json;
|
|
2358
|
+
dimLineExtend?: Json;
|
|
2359
|
+
extExtend?: Json;
|
|
2360
|
+
extLineColor?: Json;
|
|
2361
|
+
extOffset?: Json;
|
|
2362
|
+
fractionFormat?: Json;
|
|
2363
|
+
handles?: Array<string>;
|
|
2364
|
+
limits?: Json;
|
|
2365
|
+
linearFactor?: Json;
|
|
2366
|
+
linearUnit?: Json; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
2367
|
+
pick?: Array<number>;
|
|
2368
|
+
post?: Json;
|
|
2369
|
+
round?: Json;
|
|
2370
|
+
scale?: Json;
|
|
2371
|
+
suppressExt1?: Json;
|
|
2372
|
+
suppressExt2?: Json;
|
|
2373
|
+
textAbove?: Json;
|
|
2374
|
+
textColor?: Json;
|
|
2375
|
+
textGap?: Json;
|
|
2376
|
+
textHeight?: Json;
|
|
2377
|
+
textInsideHorizontal?: Json;
|
|
2378
|
+
textJust?: Json;
|
|
2379
|
+
textOutsideHorizontal?: Json;
|
|
2380
|
+
textStyle?: Json;
|
|
2381
|
+
tickSize?: Json;
|
|
2382
|
+
tolDecimals?: Json;
|
|
2383
|
+
tolMinus?: Json;
|
|
2384
|
+
tolPlus?: Json;
|
|
2385
|
+
tolScale?: Json;
|
|
2386
|
+
tolZeroSuppression?: Json;
|
|
2387
|
+
tolerance?: Json;
|
|
2388
|
+
zeroSuppression?: Json;
|
|
2389
|
+
};
|
|
2390
|
+
/** Table Style... Creates or changes a table style's text height, cell margin, title and header rows, optionally making it current. Params: {name, textHeight?, margin?, title?, header?, current?} ? styles. Reads the active. Changes the document. */
|
|
2391
|
+
"tablestyle": {
|
|
2392
|
+
current?: boolean;
|
|
2393
|
+
header?: boolean;
|
|
2394
|
+
margin?: number;
|
|
2395
|
+
name?: string;
|
|
2396
|
+
textHeight?: number;
|
|
2397
|
+
title?: string;
|
|
2398
|
+
};
|
|
2399
|
+
/** Multileader Style... Creates or changes a multileader style's arrow size, text height and style, landing gap and dogleg, optionally making it current. Params: {name, arrowSize?, textHeight?, landingGap?, dogleg?, textStyle?, current?} ? styles. Reads the active. Changes the document. */
|
|
2400
|
+
"mleaderstyle": {
|
|
2401
|
+
arrowSize?: number;
|
|
2402
|
+
current?: boolean;
|
|
2403
|
+
dogleg?: number;
|
|
2404
|
+
landingGap?: number;
|
|
2405
|
+
name?: string;
|
|
2406
|
+
textHeight?: number;
|
|
2407
|
+
textStyle?: string;
|
|
2408
|
+
};
|
|
2409
|
+
/** Point Style... Sets how point objects display (PDMODE) and their size (PDSIZE). Params: {pdmode, pdsize}. Changes the document. */
|
|
2410
|
+
"ddptype": {
|
|
2411
|
+
pdmode?: number;
|
|
2412
|
+
pdsize?: number;
|
|
2413
|
+
};
|
|
2414
|
+
/** Rename... Renames a named item (layer, linetype, text style, dimension style, block, multileader or table style, view or UCS). Params: {table: layer|linetype|style|dimstyle|block|mleaderstyle|tablestyle|view|ucs, from, to}. Reads the active. Changes the document. */
|
|
2415
|
+
"rename": {
|
|
2416
|
+
from?: string;
|
|
2417
|
+
table?: "layer" | "linetype" | "style" | "dimstyle" | "block" | "mleaderstyle" | "tablestyle" | "view" | "ucs";
|
|
2418
|
+
to?: string;
|
|
2419
|
+
};
|
|
2420
|
+
/** Distance. Measures the distance between two points and answers it with the angle and the x and y deltas. Params: {p1, p2}. */
|
|
2421
|
+
"dist": {
|
|
2422
|
+
p1?: Array<number>;
|
|
2423
|
+
p2?: Array<number>;
|
|
2424
|
+
};
|
|
2425
|
+
/** ID Point. Answers the coordinates of a point, as the ID command reports them. Params: {at}. */
|
|
2426
|
+
"id": {
|
|
2427
|
+
at?: Array<number>;
|
|
2428
|
+
};
|
|
2429
|
+
/** List. Answers a text listing of the given or selected objects' database properties, as the LIST command prints them. Params: {handles?}. Acts on `handles`. Reads the selection. */
|
|
2430
|
+
"list": {
|
|
2431
|
+
aperture?: number;
|
|
2432
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
2433
|
+
pick?: Array<number>;
|
|
2434
|
+
};
|
|
2435
|
+
/** Area. Measures the area and perimeter of a closed polygon through points, or of a closed object. Params: {points: [[x,y],...]} | {handle}. Acts on `handle`. Reads the selection. */
|
|
2436
|
+
"area": {
|
|
2437
|
+
aperture?: number;
|
|
2438
|
+
handle?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
2439
|
+
pick?: Array<number>; /** in one of several forms of the parameters */
|
|
2440
|
+
points?: Array<Array<number>>;
|
|
2441
|
+
};
|
|
2442
|
+
/** Time. Answers the drawing's revision and the number of edits recorded in this session as a message. */
|
|
2443
|
+
"time": Record<string, never>;
|
|
2444
|
+
/** Status. Answers a text report of the drawing's object count, limits, extents, current layer and settings, as STATUS prints it. Reads the active. */
|
|
2445
|
+
"status": Record<string, never>;
|
|
2446
|
+
/** Inspect Drawing. Answers an overview of the drawing: object counts by type, layers, blocks, styles, current settings and, optionally, a page of its objects. Params: {entities?: bool, limit?: n}. Reads the active, part, selection. */
|
|
2447
|
+
"drawing.inspect": {
|
|
2448
|
+
entities?: boolean;
|
|
2449
|
+
limit?: number;
|
|
2450
|
+
};
|
|
2451
|
+
/** Query Entities. Answers a page of objects of one space (Model, or a layout by `layout`, without going there; default the space shown) filtered by type, layer and a crossing or inside window, with their handles, properties and geometry and the total count. Params: {layout?: string ("Model" or a layout's name; default the space shown), type?, layer?: string (a layer name), window?: [[x,y],[x,y]], crossing?: bool (default true; false = entirely inside), limit?, offset?} ? {count (all matches), returned, offset, entities}. Reads the part. */
|
|
2452
|
+
"entities": {
|
|
2453
|
+
crossing?: boolean; /** a layer name */
|
|
2454
|
+
layer?: string; /** "Model" or a layout's name; default the space shown */
|
|
2455
|
+
layout?: string;
|
|
2456
|
+
limit?: number;
|
|
2457
|
+
offset?: number;
|
|
2458
|
+
type?: string;
|
|
2459
|
+
window?: Array<Array<number>>;
|
|
2460
|
+
};
|
|
2461
|
+
/** Count. Counts block references in model space, every block or the named one, and answers the counts with a message line. Params: {block?} ? {blocks: {name: n}} | {block, count}, plus a `message` line. */
|
|
2462
|
+
"count": {
|
|
2463
|
+
block?: string;
|
|
2464
|
+
};
|
|
2465
|
+
/** Measure Entities. Measures without changing anything: each entity's bounding box (`bounds`: handles), the minimum distance between two entities or points with the nearest points (`distance`: [a, b], each a handle or [x, y]), the points where two entities cross (`intersections`: [a, b] handles), or the pairs of duplicate objects in a space (`overlaps`: {layout?}, Model unless named; OVERKILL's report, nothing deleted). Give exactly one. Params: {bounds?: [handles], distance?: [a, b] (a handle or [x, y] each), intersections?: [a, b] (handles), overlaps?: {layout?: string}} ? bounds | {distance, from, to} | {points} | {pairs}. */
|
|
2466
|
+
"entities.measure": {
|
|
2467
|
+
bounds?: Array<string>; /** two entities (handles) or points ([x, y]) */
|
|
2468
|
+
distance?: Array<Json>; /** two entities' handles */
|
|
2469
|
+
intersections?: Array<string>; /** the space to report duplicates in */
|
|
2470
|
+
overlaps?: {
|
|
2471
|
+
layout?: string;
|
|
2472
|
+
};
|
|
2473
|
+
};
|
|
2474
|
+
/** Ortho Mode. Turns ortho mode on or off, or toggles it with no value, and answers the new state; the drawing is unchanged. Params: {on?: bool}. */
|
|
2475
|
+
"ortho": {
|
|
2476
|
+
on?: boolean;
|
|
2477
|
+
};
|
|
2478
|
+
/** Grid Display. Turns the grid display on or off, or toggles it with no value, and answers the new state; the drawing is unchanged. Params: {on?: bool}. */
|
|
2479
|
+
"grid": {
|
|
2480
|
+
on?: boolean;
|
|
2481
|
+
};
|
|
2482
|
+
/** Snap Mode. Turns snap mode on or off, or toggles it with no value, and answers the new state; the drawing is unchanged. Params: {on?: bool}. */
|
|
2483
|
+
"snap": {
|
|
2484
|
+
on?: boolean;
|
|
2485
|
+
};
|
|
2486
|
+
/** Polar Tracking. Turns polar tracking on or off, or toggles it with no value, and answers the new state; the drawing is unchanged. Params: {on?: bool}. */
|
|
2487
|
+
"polar": {
|
|
2488
|
+
on?: boolean;
|
|
2489
|
+
};
|
|
2490
|
+
/** Object Snap Tracking. Turns object snap tracking on or off, or toggles it with no value, and answers the new state; the drawing is unchanged. Params: {on?: bool}. */
|
|
2491
|
+
"otrack": {
|
|
2492
|
+
on?: boolean;
|
|
2493
|
+
};
|
|
2494
|
+
/** Dynamic Input. Turns dynamic input on or off, or toggles it with no value, and answers the new state; the drawing is unchanged. Params: {on?: bool}. */
|
|
2495
|
+
"dynmode": {
|
|
2496
|
+
on?: boolean;
|
|
2497
|
+
};
|
|
2498
|
+
/** Show/Hide Lineweight. Turns the display of lineweights on or off, or toggles it with no value, and answers the new state. Params: {on?: bool}. */
|
|
2499
|
+
"lwdisplay": {
|
|
2500
|
+
on?: boolean;
|
|
2501
|
+
};
|
|
2502
|
+
/** Isometric Drafting. Turns isometric drafting on or off, or toggles it with no value, and answers the new state. Params: {on?: bool}. */
|
|
2503
|
+
"isodraft": {
|
|
2504
|
+
on?: boolean;
|
|
2505
|
+
};
|
|
2506
|
+
/** Show/Hide Transparency. Turns the display of object transparency on or off, or toggles it with no value, and answers the new state. Params: {on?: bool}. */
|
|
2507
|
+
"transparencydisplay": {
|
|
2508
|
+
on?: boolean;
|
|
2509
|
+
};
|
|
2510
|
+
/** Quick Properties. Turns the Quick Properties palette on or off, or toggles it with no value, and answers the new state. Params: {on?: bool}. */
|
|
2511
|
+
"qpmode": {
|
|
2512
|
+
on?: boolean;
|
|
2513
|
+
};
|
|
2514
|
+
/** Selection Cycling. Turns selection cycling of overlapping objects on or off, or toggles it with no value, and answers the new state. Params: {on?: bool}. */
|
|
2515
|
+
"selectioncycling": {
|
|
2516
|
+
on?: boolean;
|
|
2517
|
+
};
|
|
2518
|
+
/** Object Snap. Turns running object snaps on or off and sets their modes by name or OSMODE bits; answers the state and the active modes. Params: {on?: bool, modes?: ["end","mid",...], osmode?: n (instead of modes)}. */
|
|
2519
|
+
"osnap": {
|
|
2520
|
+
modes?: Array<string>;
|
|
2521
|
+
on?: boolean; /** instead of modes */
|
|
2522
|
+
osmode?: number;
|
|
2523
|
+
};
|
|
2524
|
+
/** Drafting Settings... Sets drafting settings (snap and grid spacing, polar angle, major grid lines) and answers every drafting setting. Params: {snapunit?: [x,y], gridunit?: [x,y], polarang? (degrees), gridmajor?}. */
|
|
2525
|
+
"dsettings": {
|
|
2526
|
+
gridmajor?: number;
|
|
2527
|
+
gridunit?: Array<number>;
|
|
2528
|
+
polarang?: number;
|
|
2529
|
+
snapunit?: Array<number>;
|
|
2530
|
+
};
|
|
2531
|
+
/** Set Variable. Sets a system variable by name to a value, as SETVAR does. Params: {name, value}. Reads the active, part. Changes the document. */
|
|
2532
|
+
"setvar": {
|
|
2533
|
+
name?: string;
|
|
2534
|
+
value?: Json;
|
|
2535
|
+
};
|
|
2536
|
+
/** Get Variable. Answers the value of the named system variable. Params: {name}. Reads the active, part. */
|
|
2537
|
+
"getvar": {
|
|
2538
|
+
name?: string;
|
|
2539
|
+
};
|
|
2540
|
+
/** List System Variables. Answers every system variable the drawing has, by name, with its value. Reads the active, part. */
|
|
2541
|
+
"sysvars": Record<string, never>;
|
|
2542
|
+
/** QuickCalc. Evaluates an arithmetic expression, with optional named variables, as QuickCalc does, and answers the result. Params: {expr: "(3+4)*2^2", vars?: {x: 1}}. */
|
|
2543
|
+
"cal": {
|
|
2544
|
+
expr?: string;
|
|
2545
|
+
vars?: {
|
|
2546
|
+
x?: number;
|
|
2547
|
+
};
|
|
2548
|
+
};
|
|
2549
|
+
/** Find... Finds text in the text, mtext, attributes and dimensions of the current space, optionally replacing it, matching case or whole words. Params: {find, replace?, matchCase?: bool, wholeWord?: bool}. Reads the part. Changes the document. */
|
|
2550
|
+
"find": {
|
|
2551
|
+
find?: string;
|
|
2552
|
+
matchCase?: boolean;
|
|
2553
|
+
replace?: string;
|
|
2554
|
+
wholeWord?: boolean;
|
|
2555
|
+
};
|
|
2556
|
+
/** Region/Mass Properties. Answers the area, perimeter, centroid and moments of inertia of each given or selected closed object. Params: {handles?}. Acts on `handles`. Reads the selection. */
|
|
2557
|
+
"massprop": {
|
|
2558
|
+
aperture?: number;
|
|
2559
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
2560
|
+
pick?: Array<number>;
|
|
2561
|
+
};
|
|
2562
|
+
/** Measure Geometry. Measures a distance, a radius, an angle or an area, taking the parameters of dist, radius.measure, angle.measure or area. Params: {mode: distance|radius|angle|area, p1?: [x,y], p2?: [x,y] (distance, angle), vertex?: [x,y] (angle), handle?, handles? (radius, area), points?: [[x,y],...] (area)}. Acts on `handles`. Reads the selection. */
|
|
2563
|
+
"measuregeom": {
|
|
2564
|
+
aperture?: number;
|
|
2565
|
+
handle?: string;
|
|
2566
|
+
handles?: Array<string>;
|
|
2567
|
+
mode?: string;
|
|
2568
|
+
p1?: Array<number>; /** distance, angle */
|
|
2569
|
+
p2?: Array<number>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
2570
|
+
pick?: Array<number>; /** area */
|
|
2571
|
+
points?: Array<Array<number>>; /** angle */
|
|
2572
|
+
vertex?: Array<number>;
|
|
2573
|
+
};
|
|
2574
|
+
/** Radius. Answers the radius and diameter of an arc or circle. Params: {handle}. Acts on `handle`. Reads the selection. */
|
|
2575
|
+
"radius.measure": {
|
|
2576
|
+
aperture?: number;
|
|
2577
|
+
handle?: string; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
2578
|
+
pick?: Array<number>;
|
|
2579
|
+
};
|
|
2580
|
+
/** Angle. Measures the angle at a vertex between two points, or between two lines, in degrees. Params: {vertex, p1, p2} | {h1, h2}. */
|
|
2581
|
+
"angle.measure": {
|
|
2582
|
+
h1?: string;
|
|
2583
|
+
h2?: string;
|
|
2584
|
+
p1?: Array<number>;
|
|
2585
|
+
p2?: Array<number>;
|
|
2586
|
+
vertex?: Array<number>;
|
|
2587
|
+
};
|
|
2588
|
+
/** Table... Draws a table at a point with rows and columns, row height and column width, and optional cell texts, title and header row. Params: {at: [x,y], rows (data rows), cols, rowHeight? (rows grow to fit their text), colWidth? (default 63.5 in metric drawings, 2.5 in imperial), textHeight? (default: the table style's), cells?: [[text]], title?: text, header?: [text]}. Reads the active, part. Changes the document. */
|
|
2589
|
+
"table": {
|
|
2590
|
+
at?: Array<number>;
|
|
2591
|
+
cells?: Array<Array<string>>;
|
|
2592
|
+
colWidth?: number;
|
|
2593
|
+
cols?: number;
|
|
2594
|
+
header?: Array<string>; /** the layer the new objects go on, by name (default: the current layer); the drawing's current layer stays as it is */
|
|
2595
|
+
layer?: string; /** the space the new objects go in: "Model" or a layout's name (default: the space the call's part or the editor names); the space shown stays as it is */
|
|
2596
|
+
layout?: string;
|
|
2597
|
+
rowHeight?: number; /** data rows */
|
|
2598
|
+
rows?: number;
|
|
2599
|
+
textHeight?: number;
|
|
2600
|
+
title?: string;
|
|
2601
|
+
};
|
|
2602
|
+
/** Set Table Cell. Sets the text of one cell of a table, by row and column. Params: {handle, row, col, text}. Reads the selection. Changes the document. */
|
|
2603
|
+
"table.set": {
|
|
2604
|
+
col?: number;
|
|
2605
|
+
handle?: string;
|
|
2606
|
+
row?: number;
|
|
2607
|
+
text?: string;
|
|
2608
|
+
};
|
|
2609
|
+
/** Insert Row. Inserts a row into a table before a row, or appends one, with an optional height. Params: {handle, row? (insert before; default: append), height?}. Reads the selection. Changes the document. */
|
|
2610
|
+
"table.insertrow": {
|
|
2611
|
+
handle?: string;
|
|
2612
|
+
height?: number; /** insert before; default: append */
|
|
2613
|
+
row?: number;
|
|
2614
|
+
};
|
|
2615
|
+
/** Delete Row. Deletes one row of a table by its index. Params: {handle, row}. Reads the selection. Changes the document. */
|
|
2616
|
+
"table.deleterow": {
|
|
2617
|
+
handle?: string;
|
|
2618
|
+
row?: number;
|
|
2619
|
+
};
|
|
2620
|
+
/** Insert Column. Inserts a column into a table before a column, or appends one, with an optional width. Params: {handle, col? (insert before; default: append), width?}. Reads the selection. Changes the document. */
|
|
2621
|
+
"table.insertcol": {
|
|
2622
|
+
col?: number;
|
|
2623
|
+
handle?: string;
|
|
2624
|
+
width?: number;
|
|
2625
|
+
};
|
|
2626
|
+
/** Delete Column. Deletes one column of a table by its index. Params: {handle, col}. Reads the selection. Changes the document. */
|
|
2627
|
+
"table.deletecol": {
|
|
2628
|
+
col?: number;
|
|
2629
|
+
handle?: string;
|
|
2630
|
+
};
|
|
2631
|
+
/** Merge Cells. Merges a block of table cells, from a row and column over a number of rows and columns, into one cell. Params: {handle, row, col, rows, cols}. Reads the selection. Changes the document. */
|
|
2632
|
+
"table.merge": {
|
|
2633
|
+
col?: number;
|
|
2634
|
+
cols?: number;
|
|
2635
|
+
handle?: string;
|
|
2636
|
+
row?: number;
|
|
2637
|
+
rows?: number;
|
|
2638
|
+
};
|
|
2639
|
+
/** Unmerge Cells. Splits the merged table cell at a row and column back into its single cells. Params: {handle, row, col}. Reads the selection. Changes the document. */
|
|
2640
|
+
"table.unmerge": {
|
|
2641
|
+
col?: number;
|
|
2642
|
+
handle?: string;
|
|
2643
|
+
row?: number;
|
|
2644
|
+
};
|
|
2645
|
+
/** Geometric Constraint. Adds a geometric constraint of a given type between points or objects and re-solves the drawing's constraints. Params: {type: coincident|collinear|concentric|fix|parallel|perpendicular|horizontal|vertical|tangent|smooth|symmetric|equal, h1, p1?, h2?, p2?, h3?, p3?}. Changes the document. */
|
|
2646
|
+
"geomconstraint": {
|
|
2647
|
+
h1?: string;
|
|
2648
|
+
h2?: string;
|
|
2649
|
+
h3?: string;
|
|
2650
|
+
p1?: Json;
|
|
2651
|
+
p2?: Json;
|
|
2652
|
+
p3?: Json;
|
|
2653
|
+
type?: "coincident" | "collinear" | "concentric" | "fix" | "parallel" | "perpendicular" | "horizontal" | "vertical" | "tangent" | "smooth" | "symmetric" | "equal";
|
|
2654
|
+
};
|
|
2655
|
+
/** Coincident. Constrains two points, or a point and an object, to coincide, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2656
|
+
"gccoincident": {
|
|
2657
|
+
h1?: string;
|
|
2658
|
+
h2?: string;
|
|
2659
|
+
h3?: string;
|
|
2660
|
+
p1?: Json;
|
|
2661
|
+
p2?: Json;
|
|
2662
|
+
p3?: Json;
|
|
2663
|
+
};
|
|
2664
|
+
/** Perpendicular. Constrains two lines or polyline segments to stay perpendicular, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2665
|
+
"gcperpendicular": {
|
|
2666
|
+
h1?: string;
|
|
2667
|
+
h2?: string;
|
|
2668
|
+
h3?: string;
|
|
2669
|
+
p1?: Json;
|
|
2670
|
+
p2?: Json;
|
|
2671
|
+
p3?: Json;
|
|
2672
|
+
};
|
|
2673
|
+
/** Parallel. Constrains two lines or polyline segments to stay parallel, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2674
|
+
"gcparallel": {
|
|
2675
|
+
h1?: string;
|
|
2676
|
+
h2?: string;
|
|
2677
|
+
h3?: string;
|
|
2678
|
+
p1?: Json;
|
|
2679
|
+
p2?: Json;
|
|
2680
|
+
p3?: Json;
|
|
2681
|
+
};
|
|
2682
|
+
/** Tangent. Constrains a curve to stay tangent to another curve or line, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2683
|
+
"gctangent": {
|
|
2684
|
+
h1?: string;
|
|
2685
|
+
h2?: string;
|
|
2686
|
+
h3?: string;
|
|
2687
|
+
p1?: Json;
|
|
2688
|
+
p2?: Json;
|
|
2689
|
+
p3?: Json;
|
|
2690
|
+
};
|
|
2691
|
+
/** Horizontal. Constrains a line, segment or pair of points to stay horizontal, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2692
|
+
"gchorizontal": {
|
|
2693
|
+
h1?: string;
|
|
2694
|
+
h2?: string;
|
|
2695
|
+
h3?: string;
|
|
2696
|
+
p1?: Json;
|
|
2697
|
+
p2?: Json;
|
|
2698
|
+
p3?: Json;
|
|
2699
|
+
};
|
|
2700
|
+
/** Vertical. Constrains a line, segment or pair of points to stay vertical, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2701
|
+
"gcvertical": {
|
|
2702
|
+
h1?: string;
|
|
2703
|
+
h2?: string;
|
|
2704
|
+
h3?: string;
|
|
2705
|
+
p1?: Json;
|
|
2706
|
+
p2?: Json;
|
|
2707
|
+
p3?: Json;
|
|
2708
|
+
};
|
|
2709
|
+
/** Collinear. Constrains two lines or segments to lie on the same infinite line, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2710
|
+
"gccollinear": {
|
|
2711
|
+
h1?: string;
|
|
2712
|
+
h2?: string;
|
|
2713
|
+
h3?: string;
|
|
2714
|
+
p1?: Json;
|
|
2715
|
+
p2?: Json;
|
|
2716
|
+
p3?: Json;
|
|
2717
|
+
};
|
|
2718
|
+
/** Concentric. Constrains two arcs, circles or ellipses to share a centre, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2719
|
+
"gcconcentric": {
|
|
2720
|
+
h1?: string;
|
|
2721
|
+
h2?: string;
|
|
2722
|
+
h3?: string;
|
|
2723
|
+
p1?: Json;
|
|
2724
|
+
p2?: Json;
|
|
2725
|
+
p3?: Json;
|
|
2726
|
+
};
|
|
2727
|
+
/** Smooth. Constrains a spline to join another curve with smooth (curvature) continuity, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2728
|
+
"gcsmooth": {
|
|
2729
|
+
h1?: string;
|
|
2730
|
+
h2?: string;
|
|
2731
|
+
h3?: string;
|
|
2732
|
+
p1?: Json;
|
|
2733
|
+
p2?: Json;
|
|
2734
|
+
p3?: Json;
|
|
2735
|
+
};
|
|
2736
|
+
/** Symmetric. Constrains two points or objects to stay symmetric about a symmetry line, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2737
|
+
"gcsymmetric": {
|
|
2738
|
+
h1?: string;
|
|
2739
|
+
h2?: string;
|
|
2740
|
+
h3?: string;
|
|
2741
|
+
p1?: Json;
|
|
2742
|
+
p2?: Json;
|
|
2743
|
+
p3?: Json;
|
|
2744
|
+
};
|
|
2745
|
+
/** Equal. Constrains two lines to equal length, or two arcs or circles to equal radius, and re-solves the constraints. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2746
|
+
"gcequal": {
|
|
2747
|
+
h1?: string;
|
|
2748
|
+
h2?: string;
|
|
2749
|
+
h3?: string;
|
|
2750
|
+
p1?: Json;
|
|
2751
|
+
p2?: Json;
|
|
2752
|
+
p3?: Json;
|
|
2753
|
+
};
|
|
2754
|
+
/** Fix. Fixes a point or an object in place so the constraint solver cannot move it. Params: {h1, p1?, h2?, p2?, h3?, p3?} (h = handle; p = "start"/"end"/"mid"/"center"/"v<i>"/"seg<i>"/"object" or a pick point [x, y]). Changes the document. */
|
|
2755
|
+
"gcfix": {
|
|
2756
|
+
h1?: string;
|
|
2757
|
+
h2?: string;
|
|
2758
|
+
h3?: string;
|
|
2759
|
+
p1?: Json;
|
|
2760
|
+
p2?: Json;
|
|
2761
|
+
p3?: Json;
|
|
2762
|
+
};
|
|
2763
|
+
/** AutoConstrain. Infers and adds geometric constraints among the given or selected objects within distance and angle tolerances, of the chosen types. Params: {handles?, tolerance?, angleTolerance? (degrees), types?: [names]}. Acts on `handles`. Reads the selection. Changes the document. */
|
|
2764
|
+
"autoconstrain": {
|
|
2765
|
+
angleTolerance?: number; /** Pick reach in drawing units; default 0.5% of the space extents. */
|
|
2766
|
+
aperture?: number;
|
|
2767
|
+
handles?: Array<string>; /** Instead of handles: a drawing-space point [x,y], picked by the engine in the call's layout. With basis, holds what was at that point. */
|
|
2768
|
+
pick?: Array<number>;
|
|
2769
|
+
tolerance?: number; /** [names] */
|
|
2770
|
+
types?: Array<Json>;
|
|
2771
|
+
};
|
|
2772
|
+
/** Constraint Bars. Shows or hides the constraint bars of the given objects, or of every object. Params: {mode?: show|hide|showall|hideall, handles?}. Reads the selection. Changes the document. */
|
|
2773
|
+
"constraintbar": {
|
|
2774
|
+
handles?: Array<Json>;
|
|
2775
|
+
mode?: "show" | "hide" | "showall" | "hideall";
|
|
2776
|
+
};
|
|
2777
|
+
/** Show All Constraint Bars. Shows the constraint bars of every constrained object. Changes the document. */
|
|
2778
|
+
"constraintbar.showall": Record<string, never>;
|
|
2779
|
+
/** Hide All Constraint Bars. Hides the constraint bars of every constrained object. Changes the document. */
|
|
2780
|
+
"constraintbar.hideall": Record<string, never>;
|
|
2781
|
+
/** Dimensional Constraint. Adds a dimensional constraint (linear, aligned, horizontal, vertical, angular, radius or diameter) with a value or expression and re-solves. Params: {type: linear|aligned|horizontal|vertical|angular|radius|diameter, h1, p1?, h2?, p2?, expr? | value?, name?}. Changes the document. */
|
|
2782
|
+
"dimconstraint": {
|
|
2783
|
+
expr?: string;
|
|
2784
|
+
h1?: string;
|
|
2785
|
+
h2?: string;
|
|
2786
|
+
name?: string;
|
|
2787
|
+
p1?: Json;
|
|
2788
|
+
p2?: Json;
|
|
2789
|
+
type?: "linear" | "aligned" | "horizontal" | "vertical" | "angular" | "radius" | "diameter";
|
|
2790
|
+
value?: number;
|
|
2791
|
+
};
|
|
2792
|
+
/** Aligned. Adds an aligned distance constraint between two points or along a line, with a value or expression, and re-solves. Params: {h1, p1?, h2?, p2?, expr? | value?, name?}. Changes the document. */
|
|
2793
|
+
"dcaligned": {
|
|
2794
|
+
expr?: string;
|
|
2795
|
+
h1?: string;
|
|
2796
|
+
h2?: string;
|
|
2797
|
+
name?: string;
|
|
2798
|
+
p1?: Json;
|
|
2799
|
+
p2?: Json;
|
|
2800
|
+
value?: number;
|
|
2801
|
+
};
|
|
2802
|
+
/** Horizontal. Adds a horizontal distance constraint between two points, with a value or expression, and re-solves. Params: {h1, p1?, h2?, p2?, expr? | value?, name?}. Changes the document. */
|
|
2803
|
+
"dchorizontal": {
|
|
2804
|
+
expr?: string;
|
|
2805
|
+
h1?: string;
|
|
2806
|
+
h2?: string;
|
|
2807
|
+
name?: string;
|
|
2808
|
+
p1?: Json;
|
|
2809
|
+
p2?: Json;
|
|
2810
|
+
value?: number;
|
|
2811
|
+
};
|
|
2812
|
+
/** Vertical. Adds a vertical distance constraint between two points, with a value or expression, and re-solves. Params: {h1, p1?, h2?, p2?, expr? | value?, name?}. Changes the document. */
|
|
2813
|
+
"dcvertical": {
|
|
2814
|
+
expr?: string;
|
|
2815
|
+
h1?: string;
|
|
2816
|
+
h2?: string;
|
|
2817
|
+
name?: string;
|
|
2818
|
+
p1?: Json;
|
|
2819
|
+
p2?: Json;
|
|
2820
|
+
value?: number;
|
|
2821
|
+
};
|
|
2822
|
+
/** Angular. Adds an angular constraint between two lines or on an arc, with a value or expression in degrees, and re-solves. Params: {h1, p1?, h2?, p2?, expr? | value?, name?}. Changes the document. */
|
|
2823
|
+
"dcangular": {
|
|
2824
|
+
expr?: string;
|
|
2825
|
+
h1?: string;
|
|
2826
|
+
h2?: string;
|
|
2827
|
+
name?: string;
|
|
2828
|
+
p1?: Json;
|
|
2829
|
+
p2?: Json;
|
|
2830
|
+
value?: number;
|
|
2831
|
+
};
|
|
2832
|
+
/** Radius. Adds a radius constraint to an arc or circle, with a value or expression, and re-solves. Params: {h1, p1?, h2?, p2?, expr? | value?, name?}. Changes the document. */
|
|
2833
|
+
"dcradius": {
|
|
2834
|
+
expr?: string;
|
|
2835
|
+
h1?: string;
|
|
2836
|
+
h2?: string;
|
|
2837
|
+
name?: string;
|
|
2838
|
+
p1?: Json;
|
|
2839
|
+
p2?: Json;
|
|
2840
|
+
value?: number;
|
|
2841
|
+
};
|
|
2842
|
+
/** Diameter. Adds a diameter constraint to an arc or circle, with a value or expression, and re-solves. Params: {h1, p1?, h2?, p2?, expr? | value?, name?}. Changes the document. */
|
|
2843
|
+
"dcdiameter": {
|
|
2844
|
+
expr?: string;
|
|
2845
|
+
h1?: string;
|
|
2846
|
+
h2?: string;
|
|
2847
|
+
name?: string;
|
|
2848
|
+
p1?: Json;
|
|
2849
|
+
p2?: Json;
|
|
2850
|
+
value?: number;
|
|
2851
|
+
};
|
|
2852
|
+
/** Linear. Adds a horizontal or vertical distance constraint between two points, with a value or expression, and re-solves. Params: {h1, p1?, h2?, p2?, expr? | value?, name?}. Changes the document. */
|
|
2853
|
+
"dclinear": {
|
|
2854
|
+
expr?: string;
|
|
2855
|
+
h1?: string;
|
|
2856
|
+
h2?: string;
|
|
2857
|
+
name?: string;
|
|
2858
|
+
p1?: Json;
|
|
2859
|
+
p2?: Json;
|
|
2860
|
+
value?: number;
|
|
2861
|
+
};
|
|
2862
|
+
/** Dynamic Dimensions. Shows or hides the dynamic dimensional constraints of the given objects, or of every object. Params: {mode?: show|hide|showall|hideall, handles?}. Reads the selection. Changes the document. */
|
|
2863
|
+
"dcdisplay": {
|
|
2864
|
+
handles?: Array<Json>;
|
|
2865
|
+
mode?: "show" | "hide" | "showall" | "hideall";
|
|
2866
|
+
};
|
|
2867
|
+
/** Show All Dynamic Dimensions. Shows every dynamic dimensional constraint in the drawing. Changes the document. */
|
|
2868
|
+
"dcdisplay.showall": Record<string, never>;
|
|
2869
|
+
/** Hide All Dynamic Dimensions. Hides every dynamic dimensional constraint in the drawing. Changes the document. */
|
|
2870
|
+
"dcdisplay.hideall": Record<string, never>;
|
|
2871
|
+
/** Delete Constraints. Deletes the constraints on the given or selected objects, or the constraints with the given ids. Params: {handles? | ids?: [n]}. Reads the selection. Changes the document. */
|
|
2872
|
+
"delconstraint": {
|
|
2873
|
+
handles?: Array<Json>; /** one of several alternative parameters */
|
|
2874
|
+
ids?: Array<number>;
|
|
2875
|
+
};
|
|
2876
|
+
/** Parameters Manager. Lists the constraint parameters, sets one by name to a value or expression (creating a user parameter), or deletes one, then re-solves. Params: {name?: string, expr?: string, value?: number, description?: string, delete?: string (a parameter name)} (no keys lists the parameters; name with expr or value sets one, a new name making a user parameter, and re-solves; delete removes one). Changes the document. */
|
|
2877
|
+
"parameters": {
|
|
2878
|
+
delete?: string;
|
|
2879
|
+
description?: string;
|
|
2880
|
+
expr?: string;
|
|
2881
|
+
name?: string;
|
|
2882
|
+
value?: number;
|
|
2883
|
+
};
|
|
2884
|
+
/** Constraint Settings. Sets constraint inference, distance and angle tolerances, auto-constrain types, and constraint bar and dimension visibility. Params: {infer?, distanceTolerance?, angleTolerance?, autoTypes?: [names], barsVisible?, barTransparency?, dimsVisible?}. Changes the document. */
|
|
2885
|
+
"constraintsettings": {
|
|
2886
|
+
angleTolerance?: number; /** [names] */
|
|
2887
|
+
autoTypes?: Array<Json>;
|
|
2888
|
+
barTransparency?: number;
|
|
2889
|
+
barsVisible?: boolean;
|
|
2890
|
+
dimsVisible?: boolean;
|
|
2891
|
+
distanceTolerance?: number;
|
|
2892
|
+
infer?: boolean;
|
|
2893
|
+
};
|
|
2894
|
+
/** Inspect Constraints. Answers the drawing's constraints, their glyph anchors, the parameters, the constraint settings and whether everything is satisfied. Params: {} ? constraints, glyph anchors, parameters, settings. */
|
|
2895
|
+
"constraints.inspect": Record<string, never>;
|
|
2896
|
+
/** Undo. Undoes the last step of the caller's undo scope, or of the given person or agent scope (KitModel M12a). Params: {scope?: "person"|"agent"}. Changes the document. */
|
|
2897
|
+
"edit.undo": {
|
|
2898
|
+
scope?: "person" | "agent";
|
|
2899
|
+
};
|
|
2900
|
+
/** Redo. Redoes the last undone step of the caller's undo scope, or of the given person or agent scope. Params: {scope?: "person"|"agent"}. Changes the document. */
|
|
2901
|
+
"edit.redo": {
|
|
2902
|
+
scope?: "person" | "agent";
|
|
2903
|
+
};
|
|
2904
|
+
/** Command line. Runs a line typed at the command line: a command name or alias with its prompts' answers, as the person types them. Params: {text: string}. Reads the active, part, selection. Changes the document. */
|
|
2905
|
+
"commandLine": {
|
|
2906
|
+
text?: string;
|
|
2907
|
+
};
|
|
2908
|
+
/** Export. Exports the drawing as a PDF, SVG or PNG file: model space framed to its extents (a PDF fitted to its page's paper). Answers the file as base64 `data`, without saving the drawing or changing it. Params: {format: "pdf"|"svg"|"png"}. */
|
|
2909
|
+
"file.export": {
|
|
2910
|
+
format?: "pdf" | "svg" | "png";
|
|
2911
|
+
};
|
|
2912
|
+
/** Render preview. Draws a view of the drawing as a PNG, a function of the drawing and the call alone: a space by `layout` (Model when left out) fitted to its extents, or in it a `window` in drawing units, an entity framed by its handle (`objectId`) or a named `view`; `layers` draws only those layers. Never the space shown, the view or the selection, and never a change. Its `window` and `unitsPerPixel` turn a pixel into drawing coordinates. Params: {target? {layout? (a layout's name, or "Model"), window? [x1, y1, x2, y2] (drawing units), objectId? (a handle), view? (a named view), path? ("entity:<handle>")}, layers? [names], scale? (pixels per drawing unit), maxSize? (pixels on the longer side, 1 to 4096, default 1024)} ? {png (base64), mimeType, width, height, scale, layout, window, unitsPerPixel, drew}. */
|
|
2913
|
+
"file.render": {
|
|
2914
|
+
layers?: Array<string>; /** The most pixels on the longer side, 1 to 4096; default 1024. */
|
|
2915
|
+
maxSize?: number; /** Pixels per drawing unit, above 0; default: the view fitted to `maxSize`. A view larger than `maxSize` at that scale is drawn smaller. */
|
|
2916
|
+
scale?: number; /** The view: a space (`layout`), and in it a `window`, an entity (`objectId`, or a diagnostic's `path` `entity:<handle>`) or a named `view`. Without one, Model space fitted to its extents. */
|
|
2917
|
+
target?: {
|
|
2918
|
+
layout?: string;
|
|
2919
|
+
objectId?: string;
|
|
2920
|
+
path?: string;
|
|
2921
|
+
view?: string;
|
|
2922
|
+
window?: Array<number>;
|
|
2923
|
+
};
|
|
2924
|
+
};
|
|
2925
|
+
/** Synchronize viewport. Tells the engine the editor viewport's pan offset, zoom and pixel size, so its view matches what is drawn on screen. Params: {x: number, y: number, zoom: number, width: number, height: number}. */
|
|
2926
|
+
"viewport.sync": {
|
|
2927
|
+
height?: number;
|
|
2928
|
+
width?: number;
|
|
2929
|
+
x?: number;
|
|
2930
|
+
y?: number;
|
|
2931
|
+
zoom?: number;
|
|
2932
|
+
};
|
|
2933
|
+
}
|
|
2934
|
+
/** A Cad file opened with `openDocument<Drawing, CadCommands>`. */
|
|
2935
|
+
export type CadDocument = ModelDocument<Drawing, CadCommands>;
|
|
2936
|
+
export type CadContext = RequestContext<Drawing, CadCommands>;
|
|
2937
|
+
export {};
|