@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,1894 @@
|
|
|
1
|
+
import type { CommandMap, ModelDocument, ModelList, ModelMap, ModelObject, ModelText, 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
|
+
type BlobRef = {
|
|
7
|
+
hash: string;
|
|
8
|
+
mime: string;
|
|
9
|
+
size: number;
|
|
10
|
+
};
|
|
11
|
+
/** kit.slide: registered with @kition/sdk/script when this module loads. */
|
|
12
|
+
export declare const slideKit: KitDescriptor;
|
|
13
|
+
/** The fields a new `SlideFile` takes (`list.add(fields)`). */
|
|
14
|
+
export type SlideFileFields = {
|
|
15
|
+
props?: Json | null;
|
|
16
|
+
show?: Json | null;
|
|
17
|
+
headerFooter?: Json | null;
|
|
18
|
+
defaultTextStyle?: Json | null;
|
|
19
|
+
sections?: Json | null;
|
|
20
|
+
customShows?: Json | null;
|
|
21
|
+
embeddedFonts?: Json | null;
|
|
22
|
+
notesMaster?: Json | null;
|
|
23
|
+
handoutMaster?: Json | null;
|
|
24
|
+
};
|
|
25
|
+
/** A `SlideFile` of kit.slide. */
|
|
26
|
+
export interface SlideFile extends ModelObject {
|
|
27
|
+
props: Json | null;
|
|
28
|
+
show: Json | null;
|
|
29
|
+
headerFooter: Json | null;
|
|
30
|
+
defaultTextStyle: Json | null;
|
|
31
|
+
sections: Json | null;
|
|
32
|
+
customShows: Json | null;
|
|
33
|
+
embeddedFonts: Json | null;
|
|
34
|
+
/** Read-only: the kit keeps it as it is. */
|
|
35
|
+
readonly embeddedFontList: Json | null;
|
|
36
|
+
/** Read-only: the kit keeps it as it is. */
|
|
37
|
+
readonly embeddedFontRels: Json | null;
|
|
38
|
+
notesMaster: Json | null;
|
|
39
|
+
handoutMaster: Json | null;
|
|
40
|
+
/** Read-only: the kit keeps it as it is. */
|
|
41
|
+
readonly rawExt: Json | null;
|
|
42
|
+
readonly masters: ModelList<Master, MasterFields>;
|
|
43
|
+
readonly slides: ModelList<Slide, SlideFields>;
|
|
44
|
+
readonly media: ModelList<Media, MediaFields>;
|
|
45
|
+
}
|
|
46
|
+
/** The fields a new `Master` takes (`list.add(fields)`). */
|
|
47
|
+
export type MasterFields = {
|
|
48
|
+
props?: Json | null;
|
|
49
|
+
theme?: Json | null;
|
|
50
|
+
listStyles?: Json | null;
|
|
51
|
+
colorMap?: Json | null;
|
|
52
|
+
};
|
|
53
|
+
/** A `Master` of kit.slide. */
|
|
54
|
+
export interface Master extends ModelObject {
|
|
55
|
+
props: Json | null;
|
|
56
|
+
theme: Json | null;
|
|
57
|
+
listStyles: Json | null;
|
|
58
|
+
colorMap: Json | null;
|
|
59
|
+
/** Read-only: the kit keeps it as it is. */
|
|
60
|
+
readonly rawExt: Json | null;
|
|
61
|
+
readonly shapes: ModelList<Shape, ShapeFields>;
|
|
62
|
+
readonly layouts: ModelList<Layout, LayoutFields>;
|
|
63
|
+
}
|
|
64
|
+
/** The fields a new `Layout` takes (`list.add(fields)`). */
|
|
65
|
+
export type LayoutFields = {
|
|
66
|
+
props?: Json | null;
|
|
67
|
+
};
|
|
68
|
+
/** A `Layout` of kit.slide. */
|
|
69
|
+
export interface Layout extends ModelObject {
|
|
70
|
+
/** Read-only: the kit keeps it as it is. */
|
|
71
|
+
readonly identity: string | null;
|
|
72
|
+
props: Json | null;
|
|
73
|
+
readonly shapes: ModelList<Shape, ShapeFields>;
|
|
74
|
+
}
|
|
75
|
+
/** The fields a new `Slide` takes (`list.add(fields)`). */
|
|
76
|
+
export type SlideFields = {
|
|
77
|
+
layout?: string | ModelObject | null;
|
|
78
|
+
props?: Json | null;
|
|
79
|
+
background?: Json | null;
|
|
80
|
+
transition?: Json | null;
|
|
81
|
+
notes?: Json | null;
|
|
82
|
+
notesBody?: string | ModelObject | null;
|
|
83
|
+
comments?: Json | null;
|
|
84
|
+
};
|
|
85
|
+
/** A `Slide` of kit.slide. */
|
|
86
|
+
export interface Slide extends ModelObject {
|
|
87
|
+
/** The id of a `Layout`. */
|
|
88
|
+
get layout(): string | null;
|
|
89
|
+
set layout(value: Layout | string | null);
|
|
90
|
+
props: Json | null;
|
|
91
|
+
background: Json | null;
|
|
92
|
+
transition: Json | null;
|
|
93
|
+
/** Read-only: the kit keeps it as it is. */
|
|
94
|
+
readonly rawExt: Json | null;
|
|
95
|
+
notes: Json | null;
|
|
96
|
+
/** The id of a `TextBody`. */
|
|
97
|
+
get notesBody(): string | null;
|
|
98
|
+
set notesBody(value: TextBody | string | null);
|
|
99
|
+
comments: Json | null;
|
|
100
|
+
readonly animations: ModelList<Animation, AnimationFields>;
|
|
101
|
+
readonly shapes: ModelList<Shape, ShapeFields>;
|
|
102
|
+
/** Read-only: the kit keeps it as it is. */
|
|
103
|
+
readonly slideId: number | null;
|
|
104
|
+
}
|
|
105
|
+
/** The fields a new `Shape` takes (`list.add(fields)`). */
|
|
106
|
+
export type ShapeFields = {
|
|
107
|
+
kind?: "shape" | "picture" | "group" | "connector" | "table" | "chart" | "media" | "ink" | "opaque" | null;
|
|
108
|
+
name: string;
|
|
109
|
+
xfrm?: Json | null;
|
|
110
|
+
props?: Json | null;
|
|
111
|
+
text?: Json | null;
|
|
112
|
+
body?: string | ModelObject | null;
|
|
113
|
+
table?: string | ModelObject | null;
|
|
114
|
+
media?: string | ModelObject | null;
|
|
115
|
+
chart?: string | ModelObject | null;
|
|
116
|
+
};
|
|
117
|
+
/** A `Shape` of kit.slide. Read-only when `kind` is "opaque" (rule OM8). */
|
|
118
|
+
export interface Shape extends ModelObject {
|
|
119
|
+
kind: "shape" | "picture" | "group" | "connector" | "table" | "chart" | "media" | "ink" | "opaque" | null;
|
|
120
|
+
name: string;
|
|
121
|
+
xfrm: Json | null;
|
|
122
|
+
props: Json | null;
|
|
123
|
+
readonly look: ModelMap<Json>;
|
|
124
|
+
text: Json | null;
|
|
125
|
+
/** The id of a `TextBody`. */
|
|
126
|
+
get body(): string | null;
|
|
127
|
+
set body(value: TextBody | string | null);
|
|
128
|
+
readonly children: ModelList<Shape, ShapeFields>;
|
|
129
|
+
/** The id of a `Table`. */
|
|
130
|
+
get table(): string | null;
|
|
131
|
+
set table(value: Table | string | null);
|
|
132
|
+
/** The id of a `Media`. */
|
|
133
|
+
get media(): string | null;
|
|
134
|
+
set media(value: Media | string | null);
|
|
135
|
+
/** The id of a `Chart`. */
|
|
136
|
+
get chart(): string | null;
|
|
137
|
+
set chart(value: Chart | string | null);
|
|
138
|
+
/** Read-only: the kit keeps it as it is. */
|
|
139
|
+
readonly key: string | null;
|
|
140
|
+
/** Read-only: the kit keeps it as it is. */
|
|
141
|
+
readonly address: Json | null;
|
|
142
|
+
/** Read-only: the kit keeps it as it is. */
|
|
143
|
+
readonly identity: string | null;
|
|
144
|
+
}
|
|
145
|
+
/** The fields a new `Chart` takes (`list.add(fields)`). */
|
|
146
|
+
export type ChartFields = {};
|
|
147
|
+
/** A `Chart` of kit.slide. */
|
|
148
|
+
export interface Chart extends ModelObject {
|
|
149
|
+
readonly parts: ModelMap<Json>;
|
|
150
|
+
}
|
|
151
|
+
/** The fields a new `TextBody` takes (`list.add(fields)`). */
|
|
152
|
+
export type TextBodyFields = {
|
|
153
|
+
props?: Json | null;
|
|
154
|
+
};
|
|
155
|
+
/** A `TextBody` of kit.slide. */
|
|
156
|
+
export interface TextBody extends ModelObject {
|
|
157
|
+
props: Json | null;
|
|
158
|
+
readonly paragraphs: ModelList<Paragraph, ParagraphFields>;
|
|
159
|
+
}
|
|
160
|
+
/** The fields a new `Paragraph` takes (`list.add(fields)`). */
|
|
161
|
+
export type ParagraphFields = {
|
|
162
|
+
props?: Json | null;
|
|
163
|
+
};
|
|
164
|
+
/** A `Paragraph` of kit.slide. */
|
|
165
|
+
export interface Paragraph extends ModelObject {
|
|
166
|
+
props: Json | null;
|
|
167
|
+
get text(): ModelText;
|
|
168
|
+
set text(value: string);
|
|
169
|
+
}
|
|
170
|
+
/** The fields a new `Table` takes (`list.add(fields)`). */
|
|
171
|
+
export type TableFields = {
|
|
172
|
+
props?: Json | null;
|
|
173
|
+
};
|
|
174
|
+
/** A `Table` of kit.slide. */
|
|
175
|
+
export interface Table extends ModelObject {
|
|
176
|
+
props: Json | null;
|
|
177
|
+
readonly cols: ModelList<Col, ColFields>;
|
|
178
|
+
readonly rows: ModelList<Row, RowFields>;
|
|
179
|
+
readonly cells: ModelMap<Json>;
|
|
180
|
+
}
|
|
181
|
+
/** The fields a new `Col` takes (`list.add(fields)`). */
|
|
182
|
+
export type ColFields = {
|
|
183
|
+
width: number;
|
|
184
|
+
};
|
|
185
|
+
/** A `Col` of kit.slide. */
|
|
186
|
+
export interface Col extends ModelObject {
|
|
187
|
+
/** Read-only: the kit keeps it as it is. */
|
|
188
|
+
readonly identity: string | null;
|
|
189
|
+
width: number;
|
|
190
|
+
}
|
|
191
|
+
/** The fields a new `Row` takes (`list.add(fields)`). */
|
|
192
|
+
export type RowFields = {
|
|
193
|
+
height: number;
|
|
194
|
+
};
|
|
195
|
+
/** A `Row` of kit.slide. */
|
|
196
|
+
export interface Row extends ModelObject {
|
|
197
|
+
/** Read-only: the kit keeps it as it is. */
|
|
198
|
+
readonly identity: string | null;
|
|
199
|
+
height: number;
|
|
200
|
+
}
|
|
201
|
+
/** The fields a new `Animation` takes (`list.add(fields)`). */
|
|
202
|
+
export type AnimationFields = {
|
|
203
|
+
props?: Json | null;
|
|
204
|
+
};
|
|
205
|
+
/** A `Animation` of kit.slide. */
|
|
206
|
+
export interface Animation extends ModelObject {
|
|
207
|
+
props: Json | null;
|
|
208
|
+
}
|
|
209
|
+
/** The fields a new `Media` takes (`list.add(fields)`). */
|
|
210
|
+
export type MediaFields = {
|
|
211
|
+
blob?: BlobRef | null;
|
|
212
|
+
props?: Json | null;
|
|
213
|
+
};
|
|
214
|
+
/** A `Media` of kit.slide. */
|
|
215
|
+
export interface Media extends ModelObject {
|
|
216
|
+
blob: BlobRef | null;
|
|
217
|
+
props: Json | null;
|
|
218
|
+
}
|
|
219
|
+
/** The fields a new `CommentThread` takes (`list.add(fields)`). */
|
|
220
|
+
export type CommentThreadFields = {
|
|
221
|
+
anchor: Json;
|
|
222
|
+
resolved?: boolean | null;
|
|
223
|
+
legacy?: string | null;
|
|
224
|
+
wasResolved?: boolean | null;
|
|
225
|
+
};
|
|
226
|
+
/** A `CommentThread` of kit.slide. */
|
|
227
|
+
export interface CommentThread extends ModelObject {
|
|
228
|
+
anchor: Json;
|
|
229
|
+
resolved: boolean | null;
|
|
230
|
+
readonly comments: ModelList<Comment, CommentFields>;
|
|
231
|
+
legacy: string | null;
|
|
232
|
+
wasResolved: boolean | null;
|
|
233
|
+
}
|
|
234
|
+
/** The fields a new `Comment` takes (`list.add(fields)`). */
|
|
235
|
+
export type CommentFields = {
|
|
236
|
+
author: string;
|
|
237
|
+
name?: string | null;
|
|
238
|
+
created: string;
|
|
239
|
+
initials?: string | null;
|
|
240
|
+
props?: Json | null;
|
|
241
|
+
legacy?: string | null;
|
|
242
|
+
};
|
|
243
|
+
/** A `Comment` of kit.slide. */
|
|
244
|
+
export interface Comment extends ModelObject {
|
|
245
|
+
author: string;
|
|
246
|
+
name: string | null;
|
|
247
|
+
get body(): ModelText;
|
|
248
|
+
set body(value: string);
|
|
249
|
+
created: string;
|
|
250
|
+
initials: string | null;
|
|
251
|
+
props: Json | null;
|
|
252
|
+
legacy: string | null;
|
|
253
|
+
}
|
|
254
|
+
/** Every command of kit.slide, by id, with its parameters. */
|
|
255
|
+
export interface SlideCommands extends CommandMap {
|
|
256
|
+
/** New slide. Starts a new presentation, from a theme and slide size or blank, replacing the open one in this session. Params: {theme?: name, size?: [w,h] pt, blank?: bool}. Changes the document. */
|
|
257
|
+
"file.new": {
|
|
258
|
+
blank?: boolean; /** [w, h] in points */
|
|
259
|
+
size?: Array<number>;
|
|
260
|
+
theme?: string;
|
|
261
|
+
};
|
|
262
|
+
/** Open. Opens a .kslide or .pptx file from the workspace as the presentation in this session. Params: {path}. Changes the document. */
|
|
263
|
+
"file.open": {
|
|
264
|
+
path?: Json;
|
|
265
|
+
};
|
|
266
|
+
/** Open Data. Opens a presentation from base64 `data` named `name` (.kslide or .pptx) instead of a file path. Params: {name, data: base64}. Changes the document. */
|
|
267
|
+
"file.openBytes": {
|
|
268
|
+
data?: string;
|
|
269
|
+
name?: string;
|
|
270
|
+
};
|
|
271
|
+
/** Save. Saves the presentation to its file, or to `path` in `format` (kslide or pptx). Params: {path?, format?: kslide|pptx}. Changes the document. */
|
|
272
|
+
"file.save": {
|
|
273
|
+
format?: "kslide" | "pptx";
|
|
274
|
+
path?: Json;
|
|
275
|
+
};
|
|
276
|
+
/** Save As. Saves the presentation to a new file `path` (kslide or pptx by extension) and makes it the file being edited. Params: {path, format?}. Changes the document. */
|
|
277
|
+
"file.saveAs": {
|
|
278
|
+
format?: "kslide" | "pptx";
|
|
279
|
+
path?: Json;
|
|
280
|
+
};
|
|
281
|
+
/** Save as Template. Saves the presentation's theme, masters and layouts as a template file at `path`. Params: {path, format?}. */
|
|
282
|
+
"file.saveTemplate": {
|
|
283
|
+
format?: Json;
|
|
284
|
+
path?: Json;
|
|
285
|
+
};
|
|
286
|
+
/** Save to Data. Answers the presentation encoded as kslide or pptx (base64) without writing a file. Params: {format?: kslide|pptx} ? {data: base64}. */
|
|
287
|
+
"file.saveBytes": {
|
|
288
|
+
format?: "kslide" | "pptx";
|
|
289
|
+
};
|
|
290
|
+
/** Export. Writes the slides as PNG/JPEG pictures, a PDF, an outline, or a pptx/kslide copy to `path`, without changing the presentation. Params: {path, format: png|jpeg|pptx|kslide|outline|pdf, slide?: index, all?: bool, scale?: px per pt; pdf: layout?: slides|notes|handouts, perPage?: 1|2|3|4|6|9, dpi?, slides?: [index], includeHidden?, textLayer?, frame?}. Reads the part. */
|
|
291
|
+
"file.export": {
|
|
292
|
+
all?: boolean; /** dots per inch for PDF pictures */
|
|
293
|
+
dpi?: number;
|
|
294
|
+
format?: "png" | "jpeg" | "pptx" | "kslide" | "outline" | "pdf";
|
|
295
|
+
frame?: number;
|
|
296
|
+
includeHidden?: boolean;
|
|
297
|
+
path?: Json;
|
|
298
|
+
perPage?: 1 | 2 | 3 | 4 | 6 | 9; /** pixels per point for PNG/JPEG */
|
|
299
|
+
scale?: number; /** a position counted from 0 (the first is 0) */
|
|
300
|
+
slide?: number;
|
|
301
|
+
slides?: Array<number>; /** PDF: keep the text selectable */
|
|
302
|
+
textLayer?: boolean;
|
|
303
|
+
};
|
|
304
|
+
/** Export to Data. Answers the slides as a PDF, or one slide (or with `all` every slide) as a PNG/JPEG picture, in base64 `data`, without writing a file or changing the presentation. Params: {format?: pdf|png|jpeg|jpg (default pdf), slide?: index (png/jpeg; default the current one), all?: bool (png/jpeg: every slide), scale?: px per pt (png/jpeg, default 2); pdf: layout?: slides|notes|handouts, perPage?: 1|2|3|4|6|9, dpi?, slides?: [index], includeHidden?, textLayer?, frame?} ? {data: base64 (the first file), format, bytes, files?: [{slide, data}] (png/jpeg with all)}. Reads the part. */
|
|
305
|
+
"file.exportBytes": {
|
|
306
|
+
all?: boolean; /** dots per inch for PDF pictures */
|
|
307
|
+
dpi?: number; /** default pdf */
|
|
308
|
+
format?: "pdf" | "png" | "jpeg" | "jpg";
|
|
309
|
+
frame?: number;
|
|
310
|
+
includeHidden?: boolean;
|
|
311
|
+
perPage?: 1 | 2 | 3 | 4 | 6 | 9; /** pixels per point for PNG/JPEG */
|
|
312
|
+
scale?: number; /** a position counted from 0 (the first is 0); png/jpeg; default the current one */
|
|
313
|
+
slide?: number;
|
|
314
|
+
slides?: Array<number>; /** PDF: keep the text selectable */
|
|
315
|
+
textLayer?: boolean;
|
|
316
|
+
};
|
|
317
|
+
/** Render Slide. Answers one slide as a PNG (base64) with its size, the agent's preview: `target.slide` (from 1) or `target.slideId`, or `slide` (an index from 0), else the first slide, never the current one; `scale` pixels per point (default 1, at most 16), brought down so the longest side is at most `maxSize` pixels; date fields show 2000-01-01, so the same call answers the same bytes. `edit: true` draws placeholder prompts as the editor does. Params: {target?: {slide?, slideId?}, slide?: index, scale?, maxSize?, edit?: bool} ? {png: base64, width, height, slide, slideId, scale}. */
|
|
318
|
+
"file.render": {
|
|
319
|
+
edit?: boolean; /** the longest side in pixels, 16 to 8192; a larger render is brought down to it */
|
|
320
|
+
maxSize?: number;
|
|
321
|
+
scale?: number; /** a position counted from 0 (the first is 0) */
|
|
322
|
+
slide?: number; /** the slide to draw: `slide` counted from 1, or `slideId` as slide_inspect lists it */
|
|
323
|
+
target?: {
|
|
324
|
+
slide?: number;
|
|
325
|
+
slideId?: number;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
/** Close. Closes the presentation in this session. Params: {}. Changes the document. */
|
|
329
|
+
"file.close": Record<string, never>;
|
|
330
|
+
/** Properties. Sets the presentation's document properties (title, author, keywords, ...) when given, and answers them. Params: {title?, subject?, author?, keywords?, comments?, category?, company?} ? properties. Changes the document. */
|
|
331
|
+
"file.properties": {
|
|
332
|
+
author?: string;
|
|
333
|
+
category?: string;
|
|
334
|
+
comments?: string;
|
|
335
|
+
company?: string;
|
|
336
|
+
keywords?: string;
|
|
337
|
+
subject?: string;
|
|
338
|
+
title?: string;
|
|
339
|
+
};
|
|
340
|
+
/** Save AutoRecover Information. Writes an AutoRecover copy of the presentation to the host's recovery folder now. Params: {} ? {written}. Changes the document. */
|
|
341
|
+
"file.recovery.save": Record<string, never>;
|
|
342
|
+
/** Recovered slide files. Lists the AutoRecover copies in the host's recovery folder (uid, path, title, saved time). Params: {} ? [{uid, path, title, saved}]. */
|
|
343
|
+
"file.recovery.list": Record<string, never>;
|
|
344
|
+
/** Open Recovered slide files. Opens every AutoRecover copy as a recovered presentation. Params: {} ? {opened: [document index]}. Changes the document. */
|
|
345
|
+
"file.recovery.open": Record<string, never>;
|
|
346
|
+
/** Discard Recovered slide files. Deletes one AutoRecover copy (`uid`) or all of them. Params: {uid?: one entry, else all}. Changes the document. */
|
|
347
|
+
"file.recovery.discard": {
|
|
348
|
+
uid?: string;
|
|
349
|
+
};
|
|
350
|
+
/** Revert. Throws away unsaved changes and reloads the presentation from its file. Params: {}. Changes the document. */
|
|
351
|
+
"file.revert": Record<string, never>;
|
|
352
|
+
/** Next Window. Switches the editor to the next open presentation window (or window `index`). Params: {index?}. */
|
|
353
|
+
"window.next": {
|
|
354
|
+
index?: number;
|
|
355
|
+
};
|
|
356
|
+
/** Undo. Takes back the caller's last edit (the person's, or the agent's with `scope: "agent"`), leaving the other's edits in place. Params: {scope?: person|agent}. Reads the selection, part. Changes the document. */
|
|
357
|
+
"edit.undo": {
|
|
358
|
+
scope?: "person" | "agent";
|
|
359
|
+
};
|
|
360
|
+
/** Redo. Applies again the edit the caller's last undo took back, in the same scope as `edit.undo`. Params: {scope?: person|agent}. Reads the selection, part. Changes the document. */
|
|
361
|
+
"edit.redo": {
|
|
362
|
+
scope?: "person" | "agent";
|
|
363
|
+
};
|
|
364
|
+
/** Cut. Removes the selected shapes (or with `scope: "slides"` the selected slides) and puts them on the clipboard. Params: {scope?: slides, ids?, id? (one shape instead of ids), onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
365
|
+
"edit.cut": {
|
|
366
|
+
id?: Json;
|
|
367
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
368
|
+
onSlide?: number; /** slides: act on the selected slides */
|
|
369
|
+
scope?: "slides";
|
|
370
|
+
};
|
|
371
|
+
/** Copy. Copies the selected shapes or slides to the clipboard and answers their plain text. Params: {scope?: slides} ? {text}. Reads the selection, part. */
|
|
372
|
+
"edit.copy": {
|
|
373
|
+
scope?: "slides";
|
|
374
|
+
};
|
|
375
|
+
/** Paste. Pastes the clipboard (or `text` as plain text) onto the current slide, or as slides with `scope: "slides"`. Params: {text?: plain text to paste, scope?: slides}. Reads the selection, part. Changes the document. */
|
|
376
|
+
"edit.paste": {
|
|
377
|
+
scope?: "slides"; /** plain text to paste instead of the clipboard */
|
|
378
|
+
text?: string;
|
|
379
|
+
};
|
|
380
|
+
/** Paste and Match Formatting. Pastes `text` (or the clipboard) taking the destination's formatting instead of the source's. Params: {text?}. Reads the selection, part. Changes the document. */
|
|
381
|
+
"edit.pasteText": {
|
|
382
|
+
text?: string;
|
|
383
|
+
};
|
|
384
|
+
/** Duplicate. Duplicates shapes in place, slightly offset. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
385
|
+
"edit.duplicate": {
|
|
386
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
387
|
+
onSlide?: number;
|
|
388
|
+
};
|
|
389
|
+
/** Delete. Deletes shapes, or the selected slides with `scope: "slides"`. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, id? (one shape instead of ids), scope?: slides, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
390
|
+
"edit.delete": {
|
|
391
|
+
id?: Json;
|
|
392
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
393
|
+
onSlide?: number; /** slides: delete the selected slides */
|
|
394
|
+
scope?: "slides";
|
|
395
|
+
};
|
|
396
|
+
/** Select All. Selects every shape on the current slide and answers their ids. Params: {}. Reads the selection, part. */
|
|
397
|
+
"edit.selectAll": Record<string, never>;
|
|
398
|
+
/** Deselect. Clears the selection on the current slide. Params: {}. Reads the selection. */
|
|
399
|
+
"edit.deselect": Record<string, never>;
|
|
400
|
+
/** Select Objects. Selects the shapes in `ids` (on slide `onSlide`, from 1) for selection-based commands; `add`/`toggle` change the selection instead of replacing it. Answers the selection. Params: {ids?: [id], id? (one shape instead of ids), add?: bool, toggle?: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. */
|
|
401
|
+
"edit.select": {
|
|
402
|
+
add?: boolean; /** an id; one shape instead of ids */
|
|
403
|
+
id?: Json;
|
|
404
|
+
ids?: Array<number>; /** the slide the ids are on, from 1 */
|
|
405
|
+
onSlide?: number;
|
|
406
|
+
toggle?: boolean;
|
|
407
|
+
};
|
|
408
|
+
/** New Slide. Adds a slide after the current one with a layout (by name or kind such as title, titleAndContent, sectionHeader) and makes it current. Params: {layout?: layout name or kind (title, titleAndContent, sectionHeader, twoContent, comparison, titleOnly, blank, contentWithCaption, pictureWithCaption), at?: index, title?: text, body?: text}. Reads the part. Changes the document. */
|
|
409
|
+
"slide.new": {
|
|
410
|
+
at?: number;
|
|
411
|
+
body?: string; /** a layout name or kind: title, titleAndContent, sectionHeader, twoContent, comparison, titleOnly, blank, ... */
|
|
412
|
+
layout?: string;
|
|
413
|
+
title?: string;
|
|
414
|
+
};
|
|
415
|
+
/** Duplicate Slide. Duplicates slide `index` (from 0, else the current one) right after it. Params: {index?}. Reads the selection, part. Changes the document. */
|
|
416
|
+
"slide.duplicate": {
|
|
417
|
+
index?: number;
|
|
418
|
+
};
|
|
419
|
+
/** Delete Slide. Deletes slide `index` (from 0, else the current one), or the slides in `ids`. To delete several slides use `ids`: indexes shift after each deletion. Params: {index?, ids?: [slide id]} (to delete several slides, pass their ids: indexes shift after each deletion). Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
420
|
+
"slide.delete": {
|
|
421
|
+
ids?: Array<Json>; /** a position counted from 0 (the first is 0) */
|
|
422
|
+
index?: number;
|
|
423
|
+
};
|
|
424
|
+
/** Move Slide. Moves slide `from` (from 0, else the current one) to position `to`. Params: {from?: index, to: index}. Reads the part. Changes the document. */
|
|
425
|
+
"slide.move": {
|
|
426
|
+
from?: number; /** a position counted from 0 (the first is 0) */
|
|
427
|
+
to?: number;
|
|
428
|
+
};
|
|
429
|
+
/** Go to Slide. Makes slide `index` (from 0) or slide id `id` the current slide, which selection-based commands act on. Params: {index} | {id}. Acts on `id`. Reads the part. */
|
|
430
|
+
"slide.go": {
|
|
431
|
+
id?: Json; /** a position counted from 0 (the first is 0); in one of several forms of the parameters */
|
|
432
|
+
index?: number;
|
|
433
|
+
};
|
|
434
|
+
/** Next Slide. Makes the next slide current and answers its index. Params: {}. Reads the part. */
|
|
435
|
+
"slide.next": Record<string, never>;
|
|
436
|
+
/** Previous Slide. Makes the previous slide current and answers its index. Params: {}. Reads the part. */
|
|
437
|
+
"slide.previous": Record<string, never>;
|
|
438
|
+
/** First Slide. Makes the first slide current and answers its index (0). Params: {}. Reads the part. */
|
|
439
|
+
"slide.first": Record<string, never>;
|
|
440
|
+
/** Last Slide. Makes the last slide current and answers its index. Params: {}. Reads the part. */
|
|
441
|
+
"slide.last": Record<string, never>;
|
|
442
|
+
/** Select Slides. Selects slides by id or index (from 0) in the slide panel, for slide-scope commands such as `edit.cut {scope: "slides"}`. Answers the selection. Params: {ids?: [slide id], indices?: [index], add?: bool}. Acts on `ids`. Reads the selection. */
|
|
443
|
+
"slide.selectSlides": {
|
|
444
|
+
add?: boolean; /** [slide id] */
|
|
445
|
+
ids?: Array<Json>;
|
|
446
|
+
indices?: Array<number>;
|
|
447
|
+
};
|
|
448
|
+
/** Hide Slide. Hides slide `index` (from 0, else the current one) from the slide show, or shows it again with `hidden: false`. Params: {index?, hidden?: bool}. Reads the selection, part. Changes the document. */
|
|
449
|
+
"slide.hide": {
|
|
450
|
+
hidden?: boolean; /** a position counted from 0 (the first is 0) */
|
|
451
|
+
index?: number;
|
|
452
|
+
};
|
|
453
|
+
/** Layout. Applies a layout (name or kind) to slide `index` or the current one, keeping placeholder content. Params: {layout: name or kind, index?}. Reads the selection, part. Changes the document. */
|
|
454
|
+
"slide.layout": {
|
|
455
|
+
index?: number; /** a layout name or kind */
|
|
456
|
+
layout?: string;
|
|
457
|
+
};
|
|
458
|
+
/** Reset. Resets the slide's placeholders to their layout's position, size and formatting. Params: {index?}. Reads the part. Changes the document. */
|
|
459
|
+
"slide.reset": {
|
|
460
|
+
index?: number;
|
|
461
|
+
};
|
|
462
|
+
/** Notes. Sets the speaker notes of slide `index` (from 0, else the current one) to `text`. Params: {text, index?}. Reads the part. Changes the document. */
|
|
463
|
+
"slide.notes": {
|
|
464
|
+
index?: number;
|
|
465
|
+
text?: string;
|
|
466
|
+
};
|
|
467
|
+
/** Rename Slide. Sets the name of slide `index` (from 0, else the current one). Params: {name, index?}. Reads the part. Changes the document. */
|
|
468
|
+
"slide.rename": {
|
|
469
|
+
index?: number;
|
|
470
|
+
name?: string;
|
|
471
|
+
};
|
|
472
|
+
/** Add Section. Adds a section starting at slide `at` (from 0, else the current slide), optionally named. Params: {name?, at?: slide index}. Reads the part. Changes the document. */
|
|
473
|
+
"section.add": {
|
|
474
|
+
at?: number;
|
|
475
|
+
name?: string;
|
|
476
|
+
};
|
|
477
|
+
/** Rename Section. Renames section `index` (from 0). Params: {index, name}. Changes the document. */
|
|
478
|
+
"section.rename": {
|
|
479
|
+
index?: number;
|
|
480
|
+
name?: string;
|
|
481
|
+
};
|
|
482
|
+
/** Remove Section. Removes section `index`, keeping its slides unless `slides: true`. Params: {index, slides?: bool (also delete its slides)}. Reads the part. Changes the document. */
|
|
483
|
+
"section.remove": {
|
|
484
|
+
index?: number; /** also delete its slides */
|
|
485
|
+
slides?: boolean;
|
|
486
|
+
};
|
|
487
|
+
/** Remove All Sections. Removes every section; the slides stay. Params: {}. Changes the document. */
|
|
488
|
+
"section.removeAll": Record<string, never>;
|
|
489
|
+
/** Move Section. Moves section `index` with its slides to section position `to`. Params: {index, to}. Changes the document. */
|
|
490
|
+
"section.move": {
|
|
491
|
+
index?: number; /** the section position (from 0) */
|
|
492
|
+
to?: number;
|
|
493
|
+
};
|
|
494
|
+
/** Slides from Outline. Adds slides from an outline `text`: each top-level line becomes a slide title and indented lines its bullets. Params: {text}. Reads the part. Changes the document. */
|
|
495
|
+
"slide.fromOutline": {
|
|
496
|
+
text?: string;
|
|
497
|
+
};
|
|
498
|
+
/** Shapes. Inserts a preset shape (rect, roundRect, ellipse, rightArrow, star5, ...; see `shape.presets`) on the current slide at `rect` [x, y, w, h] in points, with optional text, and selects it. Params: {preset: str (a preset name: rect, roundRect, ellipse, triangle, rightArrow, star5, ...; see shape.presets), rect: [number] ([x, y, w, h] in pt), text?: str, adj?: [number] (the preset's adjust values, file units), flip?: h|v|hv}. Reads the part. Changes the document. */
|
|
499
|
+
"shape.insert": {
|
|
500
|
+
adj?: Array<number>; /** h|v|hv */
|
|
501
|
+
flip?: Json; /** a preset name: rect, roundRect, ellipse, triangle, rightArrow, star5, ...; see shape.presets */
|
|
502
|
+
preset?: string; /** [x, y, w, h] in pt */
|
|
503
|
+
rect?: Array<number>;
|
|
504
|
+
text?: string;
|
|
505
|
+
};
|
|
506
|
+
/** Shape Gallery. Lists the preset shapes `shape.insert` and `shape.change` take, with label and category. Params: {} ? [{name, label, category}]. */
|
|
507
|
+
"shape.presets": Record<string, never>;
|
|
508
|
+
/** Text Box. Inserts a text box at `rect` [x, y, w, h] points on the current slide with optional `text`, and selects it. Params: {rect?: [x,y,w,h], text?: string}. Reads the part. Changes the document. */
|
|
509
|
+
"insert.textBox": {
|
|
510
|
+
rect?: Array<number>;
|
|
511
|
+
text?: string;
|
|
512
|
+
};
|
|
513
|
+
/** Picture from File. Inserts a picture from a workspace file or base64 `data` on the current slide, at `rect` or fitted to the slide. Params: {path? | data: base64, name?, rect?: [x,y,w,h]}. Reads the selection, part. Changes the document. */
|
|
514
|
+
"insert.picture": {
|
|
515
|
+
data?: string;
|
|
516
|
+
name?: string; /** base64; one of several alternative parameters */
|
|
517
|
+
path?: Json;
|
|
518
|
+
rect?: Array<number>;
|
|
519
|
+
};
|
|
520
|
+
/** Table. Inserts a table of `rows` ? `cols` on the current slide, at `rect` or centered. Params: {rows, cols, rect?, data?: [[text]] (cell text, row by row)}. Reads the part. Changes the document. */
|
|
521
|
+
"insert.table": {
|
|
522
|
+
cols?: number; /** cell text, row by row */
|
|
523
|
+
data?: Array<Array<string>>; /** [x, y, w, h] in points */
|
|
524
|
+
rect?: Array<number>;
|
|
525
|
+
rows?: number;
|
|
526
|
+
};
|
|
527
|
+
/** Chart. Inserts a chart (column, bar, line, pie, waterfall, funnel, treemap, combo, ...) with categories and series (each with an optional color, combo type and waterfall totals) on the current slide; format.size, format.color, format.bold and format.font on it format its text. Params: {type?: column|stackedColumn|percentColumn|bar|stackedBar|percentBar|line|lineMarkers|stackedLine|area|stackedArea|pie|doughnut|scatter|bubble|radar|filledRadar|waterfall|funnel|histogram|pareto|treemap|sunburst|boxWhisker|stock|surface|combo, rect?, categories?: [..], series?: [{name, values, color?, type? (combo: column|line|area...), totals? (waterfall: indexes of total points)}], title?: text|null (default with series: one series' name, else none)}. Reads the part. Changes the document. */
|
|
528
|
+
"insert.chart": {
|
|
529
|
+
categories?: Array<Json>; /** [x, y, w, h] in points */
|
|
530
|
+
rect?: Array<number>; /** [{name, values, color?, type? (combo: column|line|area...), totals? (waterfall: indexes of total points)}]; combo: column|line|area...; waterfall: indexes of total points */
|
|
531
|
+
series?: Array<{
|
|
532
|
+
color?: string;
|
|
533
|
+
name?: string;
|
|
534
|
+
totals?: Json;
|
|
535
|
+
type?: Json;
|
|
536
|
+
values?: Json;
|
|
537
|
+
}>; /** text|null (default with series: one series' name, else none); default with series: one series' name, else none */
|
|
538
|
+
title?: Json;
|
|
539
|
+
type?: "column" | "stackedColumn" | "percentColumn" | "bar" | "stackedBar" | "percentBar" | "line" | "lineMarkers" | "stackedLine" | "area" | "stackedArea" | "pie" | "doughnut" | "scatter" | "bubble" | "radar" | "filledRadar" | "waterfall" | "funnel" | "histogram" | "pareto" | "treemap" | "sunburst" | "boxWhisker" | "stock" | "surface" | "combo";
|
|
540
|
+
};
|
|
541
|
+
/** Audio from File. Inserts an audio clip from a workspace file or base64 `data` on the current slide. Params: {path? | data: base64, name?, rect?}. Reads the part. Changes the document. */
|
|
542
|
+
"insert.audio": {
|
|
543
|
+
data?: string;
|
|
544
|
+
name?: string; /** base64; one of several alternative parameters */
|
|
545
|
+
path?: Json; /** [x, y, w, h] in points */
|
|
546
|
+
rect?: Array<number>;
|
|
547
|
+
};
|
|
548
|
+
/** Video from File. Inserts a video from a workspace file or base64 `data` on the current slide. Params: {path? | data: base64, name?, rect?}. Reads the part. Changes the document. */
|
|
549
|
+
"insert.video": {
|
|
550
|
+
data?: string;
|
|
551
|
+
name?: string; /** base64; one of several alternative parameters */
|
|
552
|
+
path?: Json; /** [x, y, w, h] in points */
|
|
553
|
+
rect?: Array<number>;
|
|
554
|
+
};
|
|
555
|
+
/** Art text. Inserts art text in one of the gallery styles on the current slide. Params: {text?, style?: 0..}. Reads the part. Changes the document. */
|
|
556
|
+
"insert.artText": {
|
|
557
|
+
style?: number;
|
|
558
|
+
text?: string;
|
|
559
|
+
};
|
|
560
|
+
/** Slide Number. Turns on the slide number placeholder on the current slide, or inserts a slide-number field in the text being edited. Params: {}. Reads the selection, part. Changes the document. */
|
|
561
|
+
"insert.slideNumber": Record<string, never>;
|
|
562
|
+
/** Date & Time. Inserts the date and time as a field in the text being edited (or the date placeholder), in a `format`. Params: {format?: datetime1..}. Reads the selection, part. Changes the document. */
|
|
563
|
+
"insert.dateTime": {
|
|
564
|
+
format?: string;
|
|
565
|
+
};
|
|
566
|
+
/** Symbol. Inserts `text` (special characters) at the text insertion point. Params: {text: character(s)}. Reads the selection, part. Changes the document. */
|
|
567
|
+
"insert.symbol": {
|
|
568
|
+
text?: string;
|
|
569
|
+
};
|
|
570
|
+
/** Link. Adds a link to a URL or to slide `slide` (from 0) on the selected text or on the shapes in `ids`; with nothing selected inserts `text` as a link. Params: {url? | slide?: index, tooltip?, text?: shown when nothing is selected, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
571
|
+
"insert.hyperlink": {
|
|
572
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
573
|
+
onSlide?: number; /** a position counted from 0 (the first is 0); one of several alternative parameters */
|
|
574
|
+
slide?: number; /** the link text, used when nothing is selected */
|
|
575
|
+
text?: string; /** the tooltip shown on hover */
|
|
576
|
+
tooltip?: string; /** a position counted from 0 (the first is 0); one of several alternative parameters */
|
|
577
|
+
url?: number;
|
|
578
|
+
};
|
|
579
|
+
/** Change Chart Type. Changes the chart `id` (else the selected chart) to another chart type, keeping its data; an unknown type is refused. Params: {type: column|stackedColumn|bar|line|area|pie|doughnut|scatter|radar|waterfall|funnel|treemap|combo|... (as insert.chart), id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
580
|
+
"chart.type": {
|
|
581
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
582
|
+
onSlide?: number; /** the chart type: column, bar, line, pie, doughnut, area, scatter, ... */
|
|
583
|
+
type?: string;
|
|
584
|
+
};
|
|
585
|
+
/** Edit Data. Replaces the categories and series values (and any series color, type or waterfall totals given) of chart `id` (else the selected chart). Params: {categories?: [..], series?: [{name, values, color?, type?, totals?}], id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
586
|
+
"chart.data": {
|
|
587
|
+
categories?: Array<Json>; /** an id */
|
|
588
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
589
|
+
onSlide?: number; /** [{name, values, color?, type?, totals?}] */
|
|
590
|
+
series?: Array<{
|
|
591
|
+
color?: string;
|
|
592
|
+
name?: string;
|
|
593
|
+
totals?: Json;
|
|
594
|
+
type?: Json;
|
|
595
|
+
values?: Json;
|
|
596
|
+
}>;
|
|
597
|
+
};
|
|
598
|
+
/** Chart Elements. Sets which chart elements show (title, legend position, data labels, gridlines), the colour palette (colorful1?4, monochrome1?13; others are refused), series colours, gap width and overlap of the selected or named chart. Params: {title?: string|null, legend?: b|t|l|r|null, dataLabels?: bool, gridlines?: bool, palette?: colorful1..colorful4|monochrome1..monochrome13, colors?: [color] (one per series, or per point when coloured by point), gapWidth?: 0..500 (%), overlap?: -100..100 (%), id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
599
|
+
"chart.options": {
|
|
600
|
+
colors?: Array<string>;
|
|
601
|
+
dataLabels?: boolean; /** 0 to 500; % */
|
|
602
|
+
gapWidth?: number;
|
|
603
|
+
gridlines?: boolean; /** an id */
|
|
604
|
+
id?: Json; /** legend position, null for none */
|
|
605
|
+
legend?: Json; /** the slide the ids are on, from 1 */
|
|
606
|
+
onSlide?: number; /** -100 to 100; % */
|
|
607
|
+
overlap?: number; /** a palette name */
|
|
608
|
+
palette?: string; /** chart title, null for none */
|
|
609
|
+
title?: Json;
|
|
610
|
+
};
|
|
611
|
+
/** Smart graphics. Inserts a smart graphic (list, process, cycle with arrows, hierarchy with connecting lines, pyramid, matrix) built from `items` in `rect` (else the lower slide) on the current slide, as a group: shape.fill, shape.line, shape.effects and format.* on the group format all its shapes. Params: {kind: list|process|cycle|hierarchy|pyramid|matrix, items: [text], rect?: [x, y, w, h], onSlide?: int (the slide the ids are on, from 1)} ? {id} (a group: format it, or its shapes, as a whole). Reads the part. Changes the document. */
|
|
612
|
+
"insert.smartGraphic": {
|
|
613
|
+
items?: Array<string>;
|
|
614
|
+
kind?: "list" | "process" | "cycle" | "hierarchy" | "pyramid" | "matrix"; /** the slide the ids are on, from 1 */
|
|
615
|
+
onSlide?: number;
|
|
616
|
+
rect?: Array<number>;
|
|
617
|
+
};
|
|
618
|
+
/** Action Buttons. Inserts an action button (back, forward, home, ...) that moves through the slide show when clicked. Params: {kind: back|forward|beginning|end|home|information|return|movie|document|sound|help|custom, rect?}. Reads the part. Changes the document. */
|
|
619
|
+
"insert.actionButton": {
|
|
620
|
+
kind?: "back" | "forward" | "beginning" | "end" | "home" | "information" | "return" | "movie" | "document" | "sound" | "help" | "custom"; /** [x, y, w, h] in points */
|
|
621
|
+
rect?: Array<number>;
|
|
622
|
+
};
|
|
623
|
+
/** Connect Shapes. Draws a connector between shapes `from` and `to` (at given connection sites or the closest pair) that follows them when they move. Params: {from: shape id, to: shape id, fromSite?, toSite?: site index (default: the closest pair), id?: existing line to glue (else a new connector), preset?: straightConnector1|bentConnector3|curvedConnector3, onSlide?: int (the slide the ids are on, from 1)} ? {id}. Acts on `id`. Reads the part. Changes the document. */
|
|
624
|
+
"shape.connect": {
|
|
625
|
+
from?: Json; /** connection site index (shape.sites) */
|
|
626
|
+
fromSite?: number; /** an existing line to glue; else a new connector */
|
|
627
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
628
|
+
onSlide?: number;
|
|
629
|
+
preset?: "straightConnector1" | "bentConnector3" | "curvedConnector3"; /** a shape id (number, number string or KitDrawing id) */
|
|
630
|
+
to?: Json; /** connection site index (shape.sites); default: the closest pair */
|
|
631
|
+
toSite?: number;
|
|
632
|
+
};
|
|
633
|
+
/** Freeform. Draws a freeform line or closed filled shape through `points` (slide points), optionally smoothed into curves. Params: {points: [[x, y], ...] slide pt (? 2), closed?: bool (filled shape), smooth?: bool (curve through the points), onSlide?: int (the slide the ids are on, from 1)} ? {id}. Reads the part. Changes the document. */
|
|
634
|
+
"shape.freeform": {
|
|
635
|
+
closed?: boolean; /** the slide the ids are on, from 1 */
|
|
636
|
+
onSlide?: number; /** [[x, y], ...] in slide points */
|
|
637
|
+
points?: Array<Array<number>>; /** curve through the points */
|
|
638
|
+
smooth?: boolean;
|
|
639
|
+
};
|
|
640
|
+
/** Connection Sites. Answers the connection sites of shape `id` as [x, y] slide points, numbered as `shape.connect` takes them. Params: {id, onSlide?: int (the slide the ids are on, from 1)} ? [[x, y]] connection sites in slide points. Acts on `id`. Reads the part. */
|
|
641
|
+
"shape.sites": {
|
|
642
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
643
|
+
onSlide?: number;
|
|
644
|
+
};
|
|
645
|
+
/** Move. Moves shapes by `dx`/`dy` or to `x`/`y` in slide points (a group member too; its group's box follows). Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {dx?, dy?: pt (relative) | x?, y?: pt (absolute), ids?, toSlide?: slide tool id, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
646
|
+
"shape.move": {
|
|
647
|
+
dx?: number; /** points; relative; one of several alternative parameters */
|
|
648
|
+
dy?: number;
|
|
649
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
650
|
+
onSlide?: number; /** destination slide id; shape identities are retained */
|
|
651
|
+
toSlide?: Json; /** one of several alternative parameters */
|
|
652
|
+
x?: number; /** points; absolute */
|
|
653
|
+
y?: number;
|
|
654
|
+
};
|
|
655
|
+
/** Size. Sets the width and/or height in points, optionally keeping the aspect ratio. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {w?, h?: pt, lockAspect?: bool, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
656
|
+
"shape.resize": {
|
|
657
|
+
h?: number;
|
|
658
|
+
ids?: Array<Json>;
|
|
659
|
+
lockAspect?: boolean; /** the slide the ids are on, from 1 */
|
|
660
|
+
onSlide?: number;
|
|
661
|
+
w?: number;
|
|
662
|
+
};
|
|
663
|
+
/** Delete Shapes. Deletes the shapes in `ids` (on slide `onSlide`, from 1). Params: {ids?: [shape id], id? (one shape instead of ids), onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the part. Changes the document. */
|
|
664
|
+
"shape.delete": {
|
|
665
|
+
id?: Json; /** [shape id] */
|
|
666
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
667
|
+
onSlide?: number;
|
|
668
|
+
};
|
|
669
|
+
/** Position and Size. Sets position and size exactly (`x`, `y`, `w`, `h` in slide points, as slide.inspect lists boxes, a group member's too). Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {x, y, w, h, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
670
|
+
"shape.setBounds": {
|
|
671
|
+
h?: number;
|
|
672
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
673
|
+
onSlide?: number;
|
|
674
|
+
w?: number;
|
|
675
|
+
x?: number;
|
|
676
|
+
y?: number;
|
|
677
|
+
};
|
|
678
|
+
/** Rotation. Rotates to `deg` degrees, or by `by` degrees. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {deg?: absolute, by?: relative, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
679
|
+
"shape.rotate": {
|
|
680
|
+
by?: number; /** absolute rotation in degrees */
|
|
681
|
+
deg?: number;
|
|
682
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
683
|
+
onSlide?: number;
|
|
684
|
+
};
|
|
685
|
+
/** Flip. Flips horizontally or vertically. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {axis: horizontal|vertical, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
686
|
+
"shape.flip": {
|
|
687
|
+
axis?: "horizontal" | "vertical";
|
|
688
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
689
|
+
onSlide?: number;
|
|
690
|
+
};
|
|
691
|
+
/** Adjust Shape. Sets a preset shape's adjustment handle `index` (corner radius, arrow head size) to `value`. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {index, value (file units), ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
692
|
+
"shape.adjust": {
|
|
693
|
+
ids?: Array<Json>; /** a position counted from 0 (the first is 0) */
|
|
694
|
+
index?: number; /** the slide the ids are on, from 1 */
|
|
695
|
+
onSlide?: number; /** the adjustment value in file units */
|
|
696
|
+
value?: number;
|
|
697
|
+
};
|
|
698
|
+
/** Change Shape. Changes the preset geometry (keeping text, fill and size). Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {preset, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
699
|
+
"shape.change": {
|
|
700
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
701
|
+
onSlide?: number;
|
|
702
|
+
preset?: string;
|
|
703
|
+
};
|
|
704
|
+
/** Shape Fill. Sets the fill: a color, none, a gradient, a picture or a pattern. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {color? | none?: true | gradient?: {stops: [[pos, color]], angle?, kind?: linear|radial} | picture?: base64 | pattern?: {preset, fg, bg} | transparency?: 0..1 | reset?: true, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
705
|
+
"shape.fill": {
|
|
706
|
+
color?: string; /** {stops: [[pos, color]], angle?, kind?: linear|radial}; one of several alternative parameters */
|
|
707
|
+
gradient?: {
|
|
708
|
+
angle?: number;
|
|
709
|
+
kind?: "linear" | "radial";
|
|
710
|
+
stops?: Array<Array<Json>>;
|
|
711
|
+
};
|
|
712
|
+
ids?: Array<Json>; /** one of several alternative parameters */
|
|
713
|
+
none?: boolean; /** the slide the ids are on, from 1 */
|
|
714
|
+
onSlide?: number; /** {preset, fg, bg}; one of several alternative parameters */
|
|
715
|
+
pattern?: {
|
|
716
|
+
bg?: Json;
|
|
717
|
+
fg?: Json;
|
|
718
|
+
preset?: string;
|
|
719
|
+
}; /** base64; one of several alternative parameters */
|
|
720
|
+
picture?: Json; /** one of several alternative parameters */
|
|
721
|
+
reset?: boolean; /** 0 to 1; one of several alternative parameters */
|
|
722
|
+
transparency?: number;
|
|
723
|
+
};
|
|
724
|
+
/** Shape Outline. Sets the outline: color or none, width in points, dash, caps, joins and arrowheads. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {color?, none?, width?: pt, dash?: solid|dot|dash|lgDash|dashDot|sysDot|sysDash, cap?, join?, head?: none|triangle|stealth|diamond|oval|arrow, tail?, reset?, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
725
|
+
"shape.line": {
|
|
726
|
+
cap?: "flat" | "round" | "square";
|
|
727
|
+
color?: string;
|
|
728
|
+
dash?: "solid" | "dot" | "dash" | "lgDash" | "dashDot" | "sysDot" | "sysDash";
|
|
729
|
+
head?: "none" | "triangle" | "stealth" | "diamond" | "oval" | "arrow";
|
|
730
|
+
ids?: Array<Json>; /** line join */
|
|
731
|
+
join?: "round" | "bevel" | "miter"; /** remove the outline */
|
|
732
|
+
none?: boolean; /** the slide the ids are on, from 1 */
|
|
733
|
+
onSlide?: number; /** back to the theme outline */
|
|
734
|
+
reset?: boolean; /** arrowhead at the line's end: none, triangle, stealth, diamond, oval, arrow */
|
|
735
|
+
tail?: string; /** points */
|
|
736
|
+
width?: number;
|
|
737
|
+
};
|
|
738
|
+
/** Shape Effects. Sets shadow, glow, soft edges, reflection, bevel or 3-D rotation effects. The shadow presets are PowerPoint's: `outer` is Offset: Bottom Right (black at 40 %, blurred 4 pt, 3 pt down and right; subtle by design), `bottom` is Offset: Bottom, `center` is Offset: Center; give {color, blur, dist, dir} (points, degrees) for a stronger one. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {shadow?: none|outer|bottom|center|inner|perspective|{color, blur, dist, dir, inner?}, glow?: none|{color, radius}, softEdges?: pt, reflection?: none|tight|half|full, bevel?: none|circle|..., reset?, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
739
|
+
"shape.effects": {
|
|
740
|
+
bevel?: Json; /** glow radius in points or custom glow; null or none removes it */
|
|
741
|
+
glow?: Json;
|
|
742
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
743
|
+
onSlide?: number;
|
|
744
|
+
reflection?: "none" | "tight" | "half" | "full"; /** remove every effect */
|
|
745
|
+
reset?: boolean; /** shadow preset or custom shadow */
|
|
746
|
+
shadow?: Json; /** soft edge radius in points; zero removes it */
|
|
747
|
+
softEdges?: number;
|
|
748
|
+
};
|
|
749
|
+
/** Quick Styles. Applies a theme quick style (0..41: style row ? accent color). Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {index: 0..41 (theme style row?accent), ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
750
|
+
"shape.quickStyle": {
|
|
751
|
+
ids?: Array<Json>; /** 0 to 41; theme style row?accent */
|
|
752
|
+
index?: number; /** the slide the ids are on, from 1 */
|
|
753
|
+
onSlide?: number;
|
|
754
|
+
};
|
|
755
|
+
/** Rename. Sets the name of shape `id` (else the selected shape), as shown in the selection pane. Params: {name, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
756
|
+
"shape.rename": {
|
|
757
|
+
id?: Json;
|
|
758
|
+
name?: string; /** the slide the ids are on, from 1 */
|
|
759
|
+
onSlide?: number;
|
|
760
|
+
};
|
|
761
|
+
/** Alt Text. Sets alternative text, or marks the shapes decorative. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {text, decorative?: bool, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
762
|
+
"shape.altText": {
|
|
763
|
+
decorative?: boolean;
|
|
764
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
765
|
+
onSlide?: number;
|
|
766
|
+
text?: string;
|
|
767
|
+
};
|
|
768
|
+
/** Show/Hide. Shows or hides shapes on the slide. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {visible?: bool, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
769
|
+
"shape.visible": {
|
|
770
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
771
|
+
onSlide?: number;
|
|
772
|
+
visible?: boolean;
|
|
773
|
+
};
|
|
774
|
+
/** Lock. Locks shapes against moving and editing, or unlocks them. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {locked?: bool, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
775
|
+
"shape.lock": {
|
|
776
|
+
ids?: Array<Json>;
|
|
777
|
+
locked?: boolean; /** the slide the ids are on, from 1 */
|
|
778
|
+
onSlide?: number;
|
|
779
|
+
};
|
|
780
|
+
/** Set as Default Shape. Makes the selected shape's formatting the default for new shapes. Params: {}. Reads the selection, part. Changes the document. */
|
|
781
|
+
"shape.setDefault": Record<string, never>;
|
|
782
|
+
/** Crop. Crops pictures by fractions (0..1) of each edge. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {left?, top?, right?, bottom?: fraction 0..1, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
783
|
+
"picture.crop": {
|
|
784
|
+
bottom?: number;
|
|
785
|
+
ids?: Array<Json>;
|
|
786
|
+
left?: number; /** the slide the ids are on, from 1 */
|
|
787
|
+
onSlide?: number;
|
|
788
|
+
right?: number;
|
|
789
|
+
top?: number;
|
|
790
|
+
};
|
|
791
|
+
/** Corrections. Sets picture brightness, contrast, saturation, grayscale, transparency or recolor. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {brightness?: -1..1, contrast?: -1..1, saturation?: 0..4, grayscale?: bool, transparency?: 0..1, reset?: bool, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
792
|
+
"picture.adjust": {
|
|
793
|
+
brightness?: number; /** -1 to 1 */
|
|
794
|
+
contrast?: number;
|
|
795
|
+
grayscale?: boolean;
|
|
796
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
797
|
+
onSlide?: number;
|
|
798
|
+
reset?: boolean; /** 0 to 4 */
|
|
799
|
+
saturation?: number; /** 0 to 1 */
|
|
800
|
+
transparency?: number;
|
|
801
|
+
};
|
|
802
|
+
/** Reset Picture. Removes the crop and corrections from pictures. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
803
|
+
"picture.reset": {
|
|
804
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
805
|
+
onSlide?: number;
|
|
806
|
+
};
|
|
807
|
+
/** Change Picture. Replaces the picture with another file or base64 data, keeping size and position. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {path? | data: base64, name?, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
808
|
+
"picture.change": {
|
|
809
|
+
data?: string;
|
|
810
|
+
ids?: Array<Json>;
|
|
811
|
+
name?: string; /** the slide the ids are on, from 1 */
|
|
812
|
+
onSlide?: number; /** base64; one of several alternative parameters */
|
|
813
|
+
path?: Json;
|
|
814
|
+
};
|
|
815
|
+
/** Playback. Sets audio/video playback options (autoplay, loop, rewind, volume, trim, fade). Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {autoplay?, loop?, rewind?, acrossSlides?, hide?, fullScreen?, volume?: 0..1, trimStart?: ms, trimEnd?: ms, fadeIn?: ms, fadeOut?: ms, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
816
|
+
"media.options": {
|
|
817
|
+
acrossSlides?: boolean;
|
|
818
|
+
autoplay?: boolean; /** milliseconds */
|
|
819
|
+
fadeIn?: number; /** milliseconds */
|
|
820
|
+
fadeOut?: number;
|
|
821
|
+
fullScreen?: boolean; /** hide while not playing */
|
|
822
|
+
hide?: boolean;
|
|
823
|
+
ids?: Array<Json>;
|
|
824
|
+
loop?: boolean; /** the slide the ids are on, from 1 */
|
|
825
|
+
onSlide?: number; /** rewind after playing */
|
|
826
|
+
rewind?: boolean; /** milliseconds */
|
|
827
|
+
trimEnd?: number; /** milliseconds */
|
|
828
|
+
trimStart?: number; /** 0 to 1 */
|
|
829
|
+
volume?: number;
|
|
830
|
+
};
|
|
831
|
+
/** Describe Drawing Objects. Answers the drawing objects (shapes, text boxes, connectors, groups, charts) in KitDrawing form: geometry, frame, fill, stroke, text. Defaults to the selection, else every object on the current slide. Params: {ids?, id? (one shape instead of ids), onSlide?: int (the slide the ids are on, from 1)} (default: the selection, else every shape on the slide). Acts on `ids`. Reads the selection, part. */
|
|
832
|
+
"drawing.describe": {
|
|
833
|
+
id?: Json;
|
|
834
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
835
|
+
onSlide?: number;
|
|
836
|
+
};
|
|
837
|
+
/** Insert Drawing Object. Inserts a KitDrawing object (shape, text box or chart) from geometry, frame, fill, stroke and text on the current slide and answers its id. Params: {kind?: shape|textBox|chart, geometry?: {preset, adjust?}, frame?: {x,y,w,h,rot?,flipH?,flipV?}, placement?: {kind: slide}, fill?, stroke?, text?, paragraphs? (instead of text), body?, warp?, chart?: {kind?, title?, categories?, series?: [{name, values, color?}], legend?, dataLabels?, gridlines?, xTitle?, yTitle?}}. Reads the part. Changes the document. */
|
|
838
|
+
"drawing.insert": {
|
|
839
|
+
body?: Json; /** {kind?, title?, categories?, series?: [{name, values, color?}], legend?, dataLabels?, gridlines?, xTitle?, yTitle?} */
|
|
840
|
+
chart?: {
|
|
841
|
+
categories?: Json;
|
|
842
|
+
dataLabels?: Json;
|
|
843
|
+
gridlines?: Json;
|
|
844
|
+
kind?: Json;
|
|
845
|
+
legend?: Json;
|
|
846
|
+
series?: Array<{
|
|
847
|
+
color?: string;
|
|
848
|
+
name?: string;
|
|
849
|
+
values?: Json;
|
|
850
|
+
}>;
|
|
851
|
+
title?: string;
|
|
852
|
+
xTitle?: Json;
|
|
853
|
+
yTitle?: Json;
|
|
854
|
+
};
|
|
855
|
+
fill?: Json; /** {x,y,w,h,rot?,flipH?,flipV?} */
|
|
856
|
+
frame?: {
|
|
857
|
+
flipH?: Json;
|
|
858
|
+
flipV?: Json;
|
|
859
|
+
h?: number;
|
|
860
|
+
rot?: Json;
|
|
861
|
+
w?: number;
|
|
862
|
+
x?: number;
|
|
863
|
+
y?: number;
|
|
864
|
+
}; /** {preset, adjust?} */
|
|
865
|
+
geometry?: {
|
|
866
|
+
adjust?: Json;
|
|
867
|
+
preset?: string;
|
|
868
|
+
};
|
|
869
|
+
kind?: "shape" | "textBox" | "chart"; /** instead of text */
|
|
870
|
+
paragraphs?: Json; /** {kind: slide} */
|
|
871
|
+
placement?: {
|
|
872
|
+
kind?: Json;
|
|
873
|
+
};
|
|
874
|
+
stroke?: Json;
|
|
875
|
+
text?: string;
|
|
876
|
+
warp?: Json;
|
|
877
|
+
};
|
|
878
|
+
/** Delete Drawing Objects. Deletes the drawing objects in `ids` (on slide `onSlide`, from 1). Params: {ids?, id? (one object instead of ids), onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the part. Changes the document. */
|
|
879
|
+
"drawing.delete": {
|
|
880
|
+
id?: Json;
|
|
881
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
882
|
+
onSlide?: number;
|
|
883
|
+
};
|
|
884
|
+
/** Transform Drawing Objects. Sets a drawing object's frame, or moves, rotates or flips it, by KitDrawing ids. Params: {ids?, id? (one object instead of ids), frame?, dx?, dy?, rotateBy?, flipH?, flipV?, onSlide?: int (the slide the ids are on, from 1)} (frame sets each object's frame; dx, dy, rotateBy, flipH and flipV change it). Acts on `ids`. Reads the part. Changes the document. */
|
|
885
|
+
"drawing.transform": {
|
|
886
|
+
dx?: number;
|
|
887
|
+
dy?: number;
|
|
888
|
+
flipH?: boolean;
|
|
889
|
+
flipV?: boolean;
|
|
890
|
+
frame?: number; /** an id; one object instead of ids */
|
|
891
|
+
id?: Json;
|
|
892
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
893
|
+
onSlide?: number; /** degrees */
|
|
894
|
+
rotateBy?: number;
|
|
895
|
+
};
|
|
896
|
+
/** Format Drawing Objects. Sets fill, stroke or geometry of drawing objects by KitDrawing ids. Params: {ids?, id? (one object instead of ids), fill?, stroke?, geometry?, effects?: {shadow?, glow?}, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the part. Changes the document. */
|
|
897
|
+
"drawing.format": {
|
|
898
|
+
effects?: {
|
|
899
|
+
glow?: Json;
|
|
900
|
+
shadow?: Json;
|
|
901
|
+
};
|
|
902
|
+
fill?: Json;
|
|
903
|
+
geometry?: Json; /** an id; one object instead of ids */
|
|
904
|
+
id?: Json;
|
|
905
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
906
|
+
onSlide?: number;
|
|
907
|
+
stroke?: Json;
|
|
908
|
+
};
|
|
909
|
+
/** Set Drawing Object Text. Sets a drawing object's text (plain or as paragraphs with runs), body properties and warp. Params: {id, text? | paragraphs?, body?: {anchor, insets, wrap, autofit}, warp?: preset | null, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the part. Changes the document. */
|
|
910
|
+
"drawing.text": {
|
|
911
|
+
body?: {
|
|
912
|
+
anchor?: Json;
|
|
913
|
+
autofit?: Json;
|
|
914
|
+
insets?: Json;
|
|
915
|
+
wrap?: Json;
|
|
916
|
+
}; /** an id */
|
|
917
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
918
|
+
onSlide?: number; /** one of several alternative parameters */
|
|
919
|
+
paragraphs?: Json; /** one of several alternative parameters */
|
|
920
|
+
text?: string; /** a text warp preset, or null for none */
|
|
921
|
+
warp?: Json;
|
|
922
|
+
};
|
|
923
|
+
/** Arrange Drawing Objects. Moves drawing objects to the front, back, forward or backward in the stacking order. Params: {ids, order: front|back|forward|backward, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the part. Changes the document. */
|
|
924
|
+
"drawing.arrange": {
|
|
925
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
926
|
+
onSlide?: number;
|
|
927
|
+
order?: "front" | "back" | "forward" | "backward";
|
|
928
|
+
};
|
|
929
|
+
/** Reconnect Connector. Moves one end of connector `id` to another object's site or to a point. Params: {id, end: start|end, to?: id, site?: n, point?: [x, y], onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the part. Changes the document. */
|
|
930
|
+
"drawing.reconnect": {
|
|
931
|
+
end?: "start" | "end"; /** an id */
|
|
932
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
933
|
+
onSlide?: number;
|
|
934
|
+
point?: Array<number>;
|
|
935
|
+
site?: number; /** an id */
|
|
936
|
+
to?: number;
|
|
937
|
+
};
|
|
938
|
+
/** Connect Drawing Objects. Draws a connector of a given geometry between drawing objects `from` and `to` and answers its id. Params: {from, to, fromSite?, toSite?, geometry?: {preset: straightConnector1|bentConnector3|curvedConnector3}}. Reads the part. Changes the document. */
|
|
939
|
+
"drawing.connect": {
|
|
940
|
+
from?: Json;
|
|
941
|
+
fromSite?: number;
|
|
942
|
+
geometry?: {
|
|
943
|
+
preset?: "straightConnector1" | "bentConnector3" | "curvedConnector3";
|
|
944
|
+
}; /** a shape id (number, number string or KitDrawing id) */
|
|
945
|
+
to?: Json;
|
|
946
|
+
toSite?: number;
|
|
947
|
+
};
|
|
948
|
+
/** Group Drawing Objects. Groups two or more drawing objects on the slide into one group and answers its id. Params: {ids, onSlide?: int (the slide the ids are on, from 1)} (two or more objects on the slide, not in a group). Acts on `ids`. Reads the part. Changes the document. */
|
|
949
|
+
"drawing.group": {
|
|
950
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
951
|
+
onSlide?: number;
|
|
952
|
+
};
|
|
953
|
+
/** Ungroup Drawing Objects. Ungroups the groups in `ids` into their members. Params: {ids, onSlide?: int (the slide the ids are on, from 1)} (groups). Acts on `ids`. Reads the part. Changes the document. */
|
|
954
|
+
"drawing.ungroup": {
|
|
955
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
956
|
+
onSlide?: number;
|
|
957
|
+
};
|
|
958
|
+
/** Change Chart. Changes a chart drawing object's kind, title, legend, data labels or data. Params: {id, ids? (one chart, instead of id), kind?, title?: text|null, legend?: top|bottom|left|right|topRight|null, dataLabels?, dataLabelPosition?, gridlines?, xTitle?, yTitle?, xAxis?: {min?, max?, major?, numberFormat?, hidden?}, yAxis?: {min?, max?, major?, numberFormat?, hidden?}, categories?, series?: [{name, values, color?}], seriesFormat?: [{index, color?, lineWidth?, marker?, smooth?, trendline?, errorBars?}], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the part. Changes the document. */
|
|
959
|
+
"drawing.chart": {
|
|
960
|
+
categories?: Array<string>;
|
|
961
|
+
dataLabelPosition?: Json;
|
|
962
|
+
dataLabels?: boolean;
|
|
963
|
+
gridlines?: boolean; /** an id */
|
|
964
|
+
id?: Json; /** one chart, instead of id */
|
|
965
|
+
ids?: Array<Json>; /** the chart kind: column, bar, line, pie, ... */
|
|
966
|
+
kind?: string; /** legend position, null for none */
|
|
967
|
+
legend?: Json; /** the slide the ids are on, from 1 */
|
|
968
|
+
onSlide?: number; /** [{name, values, color?}] */
|
|
969
|
+
series?: Array<{
|
|
970
|
+
color?: string;
|
|
971
|
+
name?: string;
|
|
972
|
+
values?: Json;
|
|
973
|
+
}>; /** [{index, color?, lineWidth?, marker?, smooth?, trendline?, errorBars?}] */
|
|
974
|
+
seriesFormat?: Array<{
|
|
975
|
+
color?: string;
|
|
976
|
+
errorBars?: Json;
|
|
977
|
+
index?: number;
|
|
978
|
+
lineWidth?: Json;
|
|
979
|
+
marker?: Json;
|
|
980
|
+
smooth?: Json;
|
|
981
|
+
trendline?: Json;
|
|
982
|
+
}>; /** chart title, null for none */
|
|
983
|
+
title?: Json; /** {min?, max?, major?, numberFormat?, hidden?} */
|
|
984
|
+
xAxis?: {
|
|
985
|
+
hidden?: boolean;
|
|
986
|
+
major?: Json;
|
|
987
|
+
max?: Json;
|
|
988
|
+
min?: Json;
|
|
989
|
+
numberFormat?: Json;
|
|
990
|
+
}; /** x axis title */
|
|
991
|
+
xTitle?: Json; /** {min?, max?, major?, numberFormat?, hidden?} */
|
|
992
|
+
yAxis?: {
|
|
993
|
+
hidden?: boolean;
|
|
994
|
+
major?: Json;
|
|
995
|
+
max?: Json;
|
|
996
|
+
min?: Json;
|
|
997
|
+
numberFormat?: Json;
|
|
998
|
+
}; /** y axis title */
|
|
999
|
+
yTitle?: Json;
|
|
1000
|
+
};
|
|
1001
|
+
/** Draw Ink Strokes. Draws ink strokes (pen, pencil or highlighter) through `points` on the current slide. Params: {strokes: [{tool?: pen|pencil|highlighter, color?, width?, points: [[x, y, pressure?], ...]}]} (slide points; members left out take the current pen). Reads the part. Changes the document. */
|
|
1002
|
+
"drawing.ink": {
|
|
1003
|
+
strokes?: Array<{
|
|
1004
|
+
color?: string;
|
|
1005
|
+
points?: Array<Json>;
|
|
1006
|
+
tool?: "pen" | "pencil" | "highlighter";
|
|
1007
|
+
width?: number;
|
|
1008
|
+
}>;
|
|
1009
|
+
};
|
|
1010
|
+
/** Erase Ink. Deletes the ink strokes a path, or a circle at `x`, `y`, touches. Params: {path: [[x, y], ...] | x, y, radius?} (deletes the strokes the path touches). Reads the part. Changes the document. */
|
|
1011
|
+
"drawing.erase": {
|
|
1012
|
+
path?: Json;
|
|
1013
|
+
radius?: number;
|
|
1014
|
+
y?: number;
|
|
1015
|
+
};
|
|
1016
|
+
/** Pen. Selects the pen ink tool in the editor with a color and width; answers the tool state. Params: {color?: hex, width?: pt}. */
|
|
1017
|
+
"draw.pen": {
|
|
1018
|
+
color?: string; /** points */
|
|
1019
|
+
width?: number;
|
|
1020
|
+
};
|
|
1021
|
+
/** Pencil. Selects the pencil ink tool in the editor; answers the tool state. Params: {color?: hex, width?: pt}. */
|
|
1022
|
+
"draw.pencil": {
|
|
1023
|
+
color?: string; /** points */
|
|
1024
|
+
width?: number;
|
|
1025
|
+
};
|
|
1026
|
+
/** Highlighter. Selects the highlighter ink tool in the editor; answers the tool state. Params: {color?: hex, width?: pt}. */
|
|
1027
|
+
"draw.highlighter": {
|
|
1028
|
+
color?: string; /** points */
|
|
1029
|
+
width?: number;
|
|
1030
|
+
};
|
|
1031
|
+
/** Eraser. Selects the ink eraser in the editor; answers the tool state. Params: {}. */
|
|
1032
|
+
"draw.eraser": Record<string, never>;
|
|
1033
|
+
/** Select. Leaves inking in the editor and goes back to selecting; answers the tool state. Params: {}. */
|
|
1034
|
+
"draw.select": Record<string, never>;
|
|
1035
|
+
/** Draw State. Answers the editor's current ink tool, color and width. Params: {}. */
|
|
1036
|
+
"draw.state": Record<string, never>;
|
|
1037
|
+
/** Bring to Front. Brings shapes to the front of the stacking order. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1038
|
+
"arrange.bringToFront": {
|
|
1039
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1040
|
+
onSlide?: number;
|
|
1041
|
+
};
|
|
1042
|
+
/** Bring Forward. Brings shapes one step forward in the stacking order. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1043
|
+
"arrange.bringForward": {
|
|
1044
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1045
|
+
onSlide?: number;
|
|
1046
|
+
};
|
|
1047
|
+
/** Send Backward. Sends shapes one step backward in the stacking order. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1048
|
+
"arrange.sendBackward": {
|
|
1049
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1050
|
+
onSlide?: number;
|
|
1051
|
+
};
|
|
1052
|
+
/** Send to Back. Sends shapes to the back of the stacking order. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1053
|
+
"arrange.sendToBack": {
|
|
1054
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1055
|
+
onSlide?: number;
|
|
1056
|
+
};
|
|
1057
|
+
/** Reorder Objects. Puts shape `id` at position `index` in the slide's stacking order (0 is the back). Params: {id, index: position in the stack (0 = back), onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the part. Changes the document. */
|
|
1058
|
+
"arrange.reorder": {
|
|
1059
|
+
id?: Json; /** position in the stack, 0 is the back */
|
|
1060
|
+
index?: number; /** the slide the ids are on, from 1 */
|
|
1061
|
+
onSlide?: number;
|
|
1062
|
+
};
|
|
1063
|
+
/** Group. Groups the shapes into one group. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1064
|
+
"arrange.group": {
|
|
1065
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1066
|
+
onSlide?: number;
|
|
1067
|
+
};
|
|
1068
|
+
/** Ungroup. Ungroups the selected groups into their members. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1069
|
+
"arrange.ungroup": {
|
|
1070
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1071
|
+
onSlide?: number;
|
|
1072
|
+
};
|
|
1073
|
+
/** Regroup. Groups again the shapes that were last ungrouped. Params: {}. Reads the selection, part. Changes the document. */
|
|
1074
|
+
"arrange.regroup": Record<string, never>;
|
|
1075
|
+
/** Align. Aligns shapes' left, center, right, top, middle or bottom edges to the slide or to the selection. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {edge: left|center|right|top|middle|bottom, to?: slide|selection (default: slide for one object), ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1076
|
+
"arrange.align": {
|
|
1077
|
+
edge?: "left" | "center" | "right" | "top" | "middle" | "bottom";
|
|
1078
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1079
|
+
onSlide?: number; /** default: slide for one object */
|
|
1080
|
+
to?: "slide" | "selection";
|
|
1081
|
+
};
|
|
1082
|
+
/** Distribute. Spaces shapes evenly across or down the slide or the selection. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {dir: horizontal|vertical, to?: slide|selection, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1083
|
+
"arrange.distribute": {
|
|
1084
|
+
dir?: "horizontal" | "vertical";
|
|
1085
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1086
|
+
onSlide?: number;
|
|
1087
|
+
to?: "slide" | "selection";
|
|
1088
|
+
};
|
|
1089
|
+
/** Rotate Left 90?. Rotates shapes 90? counter-clockwise. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1090
|
+
"arrange.rotateLeft": {
|
|
1091
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1092
|
+
onSlide?: number;
|
|
1093
|
+
};
|
|
1094
|
+
/** Rotate Right 90?. Rotates shapes 90? clockwise. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1095
|
+
"arrange.rotateRight": {
|
|
1096
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1097
|
+
onSlide?: number;
|
|
1098
|
+
};
|
|
1099
|
+
/** Flip Horizontal. Flips shapes horizontally. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1100
|
+
"arrange.flipHorizontal": {
|
|
1101
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1102
|
+
onSlide?: number;
|
|
1103
|
+
};
|
|
1104
|
+
/** Flip Vertical. Flips shapes vertically. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1105
|
+
"arrange.flipVertical": {
|
|
1106
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1107
|
+
onSlide?: number;
|
|
1108
|
+
};
|
|
1109
|
+
/** Nudge. Moves shapes by `dx`/`dy` points, as the arrow keys do. Applies to the shapes in `ids` (on slide `onSlide`, from 1) or else the selection. Params: {dx, dy, ids?, onSlide?: int (the slide the ids are on, from 1)} (arrow keys: 6 pt, with Alt 1 pt). Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1110
|
+
"arrange.nudge": {
|
|
1111
|
+
dx?: number;
|
|
1112
|
+
dy?: number;
|
|
1113
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1114
|
+
onSlide?: number;
|
|
1115
|
+
};
|
|
1116
|
+
/** Merge Shapes. Merges shapes (union, combine, fragment, intersect, subtract) into new shapes; the first shape gives the formatting. Params: {op: union|combine|fragment|intersect|subtract, ids?: shapes in selection order (the first one's formatting is kept), onSlide?: int (the slide the ids are on, from 1)} ? {ids}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1117
|
+
"shape.merge": {
|
|
1118
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1119
|
+
onSlide?: number;
|
|
1120
|
+
op?: "union" | "combine" | "fragment" | "intersect" | "subtract";
|
|
1121
|
+
};
|
|
1122
|
+
/** Edit Text. Starts editing the text of shape `id` (or a table cell, or the notes) with the insertion point at a paragraph and character, for the `text.*` typing commands. Params: {id?, at?: [paragraph, char], end?: bool, cell?: [row, col], notes?: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1123
|
+
"text.edit": {
|
|
1124
|
+
at?: Array<number>; /** [row, col] */
|
|
1125
|
+
cell?: Array<number>;
|
|
1126
|
+
end?: boolean; /** an id */
|
|
1127
|
+
id?: Json;
|
|
1128
|
+
notes?: boolean; /** the slide the ids are on, from 1 */
|
|
1129
|
+
onSlide?: number;
|
|
1130
|
+
};
|
|
1131
|
+
/** Stop Editing Text. Stops editing text and selects the shape that was edited. Params: {}. Reads the selection. */
|
|
1132
|
+
"text.exit": Record<string, never>;
|
|
1133
|
+
/** Type Text. Types `text` at the insertion point of the text being edited (`\n` starts a paragraph). Needs `text.edit` first; to replace a shape's whole text use `text.set`. Params: {text} (\n = new paragraph, \u000b = line break). Reads the selection, part. Changes the document. */
|
|
1134
|
+
"text.insert": {
|
|
1135
|
+
text?: string;
|
|
1136
|
+
};
|
|
1137
|
+
/** Delete Text. Deletes a character or word backward or forward from the insertion point of the text being edited. Params: {dir?: backward|forward|wordBackward|wordForward}. Reads the selection, part. Changes the document. */
|
|
1138
|
+
"text.delete": {
|
|
1139
|
+
dir?: "backward" | "forward" | "wordBackward" | "wordForward";
|
|
1140
|
+
};
|
|
1141
|
+
/** Move Insertion Point. Moves the insertion point of the text being edited (left, right, word, line, paragraph, start, end), extending the selection with `extend`. Params: {to: left|right|up|down|wordLeft|wordRight|lineStart|lineEnd|paraStart|paraEnd|start|end, extend?: bool}. Reads the selection, part. */
|
|
1142
|
+
"text.move": {
|
|
1143
|
+
extend?: boolean;
|
|
1144
|
+
to?: "left" | "right" | "up" | "down" | "wordLeft" | "wordRight" | "lineStart" | "lineEnd" | "paraStart" | "paraEnd" | "start" | "end";
|
|
1145
|
+
};
|
|
1146
|
+
/** Select Text. Selects text from `anchor` to `caret` ([paragraph, character]) in the text being edited. Params: {anchor: [p, c], caret: [p, c]}. Reads the selection. */
|
|
1147
|
+
"text.select": {
|
|
1148
|
+
anchor?: Array<number>; /** [p, c] */
|
|
1149
|
+
caret?: Array<number>;
|
|
1150
|
+
};
|
|
1151
|
+
/** Select All Text. Selects all the text of the shape being edited. Params: {}. Reads the selection, part. */
|
|
1152
|
+
"text.selectAll": Record<string, never>;
|
|
1153
|
+
/** Select Word. Selects the word at the insertion point (or at `at`) in the text being edited. Params: {at?: [p, c]}. Reads the selection, part. */
|
|
1154
|
+
"text.selectWord": {
|
|
1155
|
+
at?: Array<number>;
|
|
1156
|
+
};
|
|
1157
|
+
/** Select Paragraph. Selects the paragraph at the insertion point (or at `at`) in the text being edited. Params: {at?: [p, c]}. Reads the selection, part. */
|
|
1158
|
+
"text.selectParagraph": {
|
|
1159
|
+
at?: Array<number>;
|
|
1160
|
+
};
|
|
1161
|
+
/** Set Text. Replaces all the text of shape `id` (or a table cell) with `text`, keeping the first run's formatting. The way to write a shape's text without `text.edit`. Params: {id?, text, cell?: [r, c], onSlide?: int (the slide the ids are on, from 1)} ? replaces the whole text, keeping the first run's formatting. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1162
|
+
"text.set": {
|
|
1163
|
+
cell?: Array<number>; /** an id */
|
|
1164
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1165
|
+
onSlide?: number;
|
|
1166
|
+
text?: string;
|
|
1167
|
+
};
|
|
1168
|
+
/** Get Text. Answers the text of shape `id` (else the selected shape) as plain text and as paragraphs with runs. Params: {id?, onSlide?: int (the slide the ids are on, from 1)} ? {text, paragraphs}. Acts on `id`. Reads the selection, part. */
|
|
1169
|
+
"text.get": {
|
|
1170
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1171
|
+
onSlide?: number;
|
|
1172
|
+
};
|
|
1173
|
+
/** Bold. Turns bold on or off (toggles without `on`) for the selected text or the whole text of shapes in `ids` (on slide `onSlide`, from 1). Params: {ids?: [shape id], on?: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1174
|
+
"format.bold": {
|
|
1175
|
+
ids?: Array<Json>;
|
|
1176
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1177
|
+
onSlide?: number;
|
|
1178
|
+
};
|
|
1179
|
+
/** Italic. Turns italic on or off for the selected text or the whole text of shapes in `ids`. Params: {ids?: [shape id], on?: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1180
|
+
"format.italic": {
|
|
1181
|
+
ids?: Array<Json>;
|
|
1182
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1183
|
+
onSlide?: number;
|
|
1184
|
+
};
|
|
1185
|
+
/** Underline. Turns underline on or off, in a style, for the selected text or the whole text of shapes in `ids`. Params: {ids?: [shape id], on?: bool, style?: sng|dbl|heavy|dotted|dash|wavy, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1186
|
+
"format.underline": {
|
|
1187
|
+
ids?: Array<Json>;
|
|
1188
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1189
|
+
onSlide?: number;
|
|
1190
|
+
style?: "sng" | "dbl" | "heavy" | "dotted" | "dash" | "wavy";
|
|
1191
|
+
};
|
|
1192
|
+
/** Strikethrough. Turns single or double strikethrough on or off for the selected text or shapes in `ids`. Params: {ids?: [shape id], on?: bool, double?: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1193
|
+
"format.strikethrough": {
|
|
1194
|
+
double?: boolean; /** [shape id] */
|
|
1195
|
+
ids?: Array<Json>;
|
|
1196
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1197
|
+
onSlide?: number;
|
|
1198
|
+
};
|
|
1199
|
+
/** Superscript. Turns superscript on or off for the selected text or shapes in `ids`. Params: {ids?: [shape id], on?: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1200
|
+
"format.superscript": {
|
|
1201
|
+
ids?: Array<Json>;
|
|
1202
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1203
|
+
onSlide?: number;
|
|
1204
|
+
};
|
|
1205
|
+
/** Subscript. Turns subscript on or off for the selected text or shapes in `ids`. Params: {ids?: [shape id], on?: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1206
|
+
"format.subscript": {
|
|
1207
|
+
ids?: Array<Json>;
|
|
1208
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1209
|
+
onSlide?: number;
|
|
1210
|
+
};
|
|
1211
|
+
/** Font. Sets the font family of the selected text or the whole text of shapes in `ids`; the answer says when this machine lacks the font and what draws it. Params: {ids?: [shape id], family, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1212
|
+
"format.font": {
|
|
1213
|
+
family?: string; /** [shape id] */
|
|
1214
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1215
|
+
onSlide?: number;
|
|
1216
|
+
};
|
|
1217
|
+
/** Font Size. Sets the font size in points of the selected text or shapes in `ids`. Params: {ids?: [shape id], size: pt, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1218
|
+
"format.size": {
|
|
1219
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1220
|
+
onSlide?: number; /** points */
|
|
1221
|
+
size?: number;
|
|
1222
|
+
};
|
|
1223
|
+
/** Increase Font Size. Increases the font size one step of the size list for the selected text or shapes in `ids`. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1224
|
+
"format.grow": {
|
|
1225
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1226
|
+
onSlide?: number;
|
|
1227
|
+
};
|
|
1228
|
+
/** Decrease Font Size. Decreases the font size one step of the size list for the selected text or shapes in `ids`. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1229
|
+
"format.shrink": {
|
|
1230
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1231
|
+
onSlide?: number;
|
|
1232
|
+
};
|
|
1233
|
+
/** Font Color. Sets the font color (hex, a theme color such as accent1, or a scheme color with modifiers) of the selected text or the whole text of shapes in `ids`. Params: {ids?: [shape id], color: #RRGGBB | accent1..6 | tx1... | {scheme, lumMod...}, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1234
|
+
"format.color": {
|
|
1235
|
+
color?: Json; /** [shape id] */
|
|
1236
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1237
|
+
onSlide?: number;
|
|
1238
|
+
};
|
|
1239
|
+
/** Text Highlight Color. Sets or removes the text highlight color of the selected text or shapes in `ids`. Params: {ids?: [shape id], color? (absent = none), onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1240
|
+
"format.highlight": {
|
|
1241
|
+
color?: string; /** [shape id] */
|
|
1242
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1243
|
+
onSlide?: number;
|
|
1244
|
+
};
|
|
1245
|
+
/** Change Case. Changes the case (sentence, lower, upper, title, toggle) of the selected text or shapes in `ids`. Params: {ids?: [shape id], mode: sentence|lower|upper|title|toggle, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1246
|
+
"format.case": {
|
|
1247
|
+
ids?: Array<Json>;
|
|
1248
|
+
mode?: "sentence" | "lower" | "upper" | "title" | "toggle"; /** the slide the ids are on, from 1 */
|
|
1249
|
+
onSlide?: number;
|
|
1250
|
+
};
|
|
1251
|
+
/** Caps. Sets small caps or all caps (or none) for the selected text or shapes in `ids`. Params: {ids?: [shape id], caps: none|small|all, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1252
|
+
"format.caps": {
|
|
1253
|
+
caps?: "none" | "small" | "all"; /** [shape id] */
|
|
1254
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1255
|
+
onSlide?: number;
|
|
1256
|
+
};
|
|
1257
|
+
/** Character Spacing. Sets character spacing in points for the selected text or shapes in `ids`. Params: {ids?: [shape id], pt, onSlide?: int (the slide the ids are on, from 1)} (veryTight -3, tight -1.5, normal 0, loose 3, veryLoose 6). Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1258
|
+
"format.spacing": {
|
|
1259
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1260
|
+
onSlide?: number; /** character spacing in points (veryTight -3, tight -1.5, normal 0, loose 3, veryLoose 6) */
|
|
1261
|
+
pt?: number;
|
|
1262
|
+
};
|
|
1263
|
+
/** Clear All Formatting. Removes character formatting from the selected text or shapes in `ids`, back to the placeholder's style. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1264
|
+
"format.clear": {
|
|
1265
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1266
|
+
onSlide?: number;
|
|
1267
|
+
};
|
|
1268
|
+
/** Text Shadow. Turns a text shadow on or off for the selected text or shapes in `ids`. Params: {ids?: [shape id], on?: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1269
|
+
"format.textShadow": {
|
|
1270
|
+
ids?: Array<Json>;
|
|
1271
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1272
|
+
onSlide?: number;
|
|
1273
|
+
};
|
|
1274
|
+
/** Text Outline. Sets a text outline color and width (or none) for the selected text or shapes in `ids`. Params: {ids?: [shape id], color?, width?: pt, onSlide?: int (the slide the ids are on, from 1)} (no color = none). Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1275
|
+
"format.textOutline": {
|
|
1276
|
+
color?: string; /** [shape id] */
|
|
1277
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1278
|
+
onSlide?: number; /** points */
|
|
1279
|
+
width?: number;
|
|
1280
|
+
};
|
|
1281
|
+
/** Transform. Applies an art text warp (arch, circle, wave, inflate, ...) to shapes in `ids` or the selection. Params: {ids?: [shape id], preset: textArchUp|textArchDown|textCircle|textWave1|textInflate|textDeflate|textSlantUp|... (none = no transform), onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1282
|
+
"format.transform": {
|
|
1283
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1284
|
+
onSlide?: number; /** a text warp preset: textArchUp, textArchDown, textCircle, textWave1, textInflate, textDeflate, ... */
|
|
1285
|
+
preset?: string;
|
|
1286
|
+
};
|
|
1287
|
+
/** Align. Sets paragraph alignment (left, center, right, justify, distributed) of the selected paragraphs or the shapes in `ids`. Params: {ids?: [shape id], align: left|center|right|justify|justifyLow|distributed, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1288
|
+
"format.align": {
|
|
1289
|
+
align?: "left" | "center" | "right" | "justify" | "justifyLow" | "distributed"; /** [shape id] */
|
|
1290
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1291
|
+
onSlide?: number;
|
|
1292
|
+
};
|
|
1293
|
+
/** Right-to-Left Text Direction. Sets right-to-left (or left-to-right) paragraph direction for the selected paragraphs or shapes in `ids`. Params: {ids?: [shape id], on?: bool, onSlide?: int (the slide the ids are on, from 1)} (off = left-to-right; switching mirrors left/right alignment). Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1294
|
+
"format.rtl": {
|
|
1295
|
+
ids?: Array<Json>;
|
|
1296
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1297
|
+
onSlide?: number;
|
|
1298
|
+
};
|
|
1299
|
+
/** Align Left. Aligns the selected paragraphs, or shapes in `ids`, left. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1300
|
+
"format.alignLeft": {
|
|
1301
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1302
|
+
onSlide?: number;
|
|
1303
|
+
};
|
|
1304
|
+
/** Center. Centers the selected paragraphs, or shapes in `ids`. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1305
|
+
"format.alignCenter": {
|
|
1306
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1307
|
+
onSlide?: number;
|
|
1308
|
+
};
|
|
1309
|
+
/** Align Right. Aligns the selected paragraphs, or shapes in `ids`, right. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1310
|
+
"format.alignRight": {
|
|
1311
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1312
|
+
onSlide?: number;
|
|
1313
|
+
};
|
|
1314
|
+
/** Justify. Justifies the selected paragraphs, or shapes in `ids`. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1315
|
+
"format.justify": {
|
|
1316
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1317
|
+
onSlide?: number;
|
|
1318
|
+
};
|
|
1319
|
+
/** Bullets. Turns bullets on or off, with a character, color and size, for the selected paragraphs or shapes in `ids`. Params: {ids?: [shape id], on?: bool, char?: ?|?|?|?|?|?|?|?, color?, size?: % of text, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1320
|
+
"format.bullets": {
|
|
1321
|
+
char?: string;
|
|
1322
|
+
color?: string; /** [shape id] */
|
|
1323
|
+
ids?: Array<Json>;
|
|
1324
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1325
|
+
onSlide?: number; /** bullet size in % of the text */
|
|
1326
|
+
size?: number;
|
|
1327
|
+
};
|
|
1328
|
+
/** Numbering. Turns numbering on or off, with a scheme and start number, for the selected paragraphs or shapes in `ids`. Params: {ids?: [shape id], on?: bool, scheme?: arabicPeriod|arabicParenR|romanUcPeriod|romanLcPeriod|alphaUcPeriod|alphaLcParenR|alphaLcPeriod, start?: n, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1329
|
+
"format.numbering": {
|
|
1330
|
+
ids?: Array<Json>;
|
|
1331
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1332
|
+
onSlide?: number;
|
|
1333
|
+
scheme?: "arabicPeriod" | "arabicParenR" | "romanUcPeriod" | "romanLcPeriod" | "alphaUcPeriod" | "alphaLcParenR" | "alphaLcPeriod";
|
|
1334
|
+
start?: number;
|
|
1335
|
+
};
|
|
1336
|
+
/** Increase List Level. Raises the list level of the selected paragraphs or shapes in `ids` by one. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1337
|
+
"format.indent": {
|
|
1338
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1339
|
+
onSlide?: number;
|
|
1340
|
+
};
|
|
1341
|
+
/** Decrease List Level. Lowers the list level of the selected paragraphs or shapes in `ids` by one. Params: {ids?: [shape id], onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1342
|
+
"format.outdent": {
|
|
1343
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1344
|
+
onSlide?: number;
|
|
1345
|
+
};
|
|
1346
|
+
/** Line Spacing. Sets line spacing as a multiple or exact points for the selected paragraphs or shapes in `ids`. Params: {ids?: [shape id], lines?: 1.0|1.5|2.0..., pt?: exactly, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1347
|
+
"format.lineSpacing": {
|
|
1348
|
+
ids?: Array<Json>; /** line spacing in lines (1.0, 1.5, 2.0, ...) */
|
|
1349
|
+
lines?: number; /** the slide the ids are on, from 1 */
|
|
1350
|
+
onSlide?: number; /** exact line spacing in points */
|
|
1351
|
+
pt?: number;
|
|
1352
|
+
};
|
|
1353
|
+
/** Paragraph. Sets paragraph alignment, indents and spacing before/after for the selected paragraphs or shapes in `ids`. Params: {ids?: [shape id], align?, indentLeft?: pt, indentFirst?: pt (negative = hanging), spaceBefore?: pt, spaceAfter?: pt, lineSpacing?: lines, lineSpacingPt?: pt (exact, instead of lineSpacing), onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1354
|
+
"format.paragraph": {
|
|
1355
|
+
align?: "left" | "center" | "right" | "justify" | "justifyLow" | "distributed"; /** [shape id] */
|
|
1356
|
+
ids?: Array<Json>; /** points; negative = hanging */
|
|
1357
|
+
indentFirst?: number; /** points */
|
|
1358
|
+
indentLeft?: number; /** line spacing in lines */
|
|
1359
|
+
lineSpacing?: number; /** points; exact, instead of lineSpacing */
|
|
1360
|
+
lineSpacingPt?: number; /** the slide the ids are on, from 1 */
|
|
1361
|
+
onSlide?: number; /** points */
|
|
1362
|
+
spaceAfter?: number; /** points */
|
|
1363
|
+
spaceBefore?: number;
|
|
1364
|
+
};
|
|
1365
|
+
/** Align Text. Sets the vertical alignment of text (top, middle, bottom) in shapes in `ids` or the selection. Params: {ids?: [shape id], anchor: top|middle|bottom, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1366
|
+
"format.anchor": {
|
|
1367
|
+
anchor?: "top" | "middle" | "bottom"; /** [shape id] */
|
|
1368
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1369
|
+
onSlide?: number;
|
|
1370
|
+
};
|
|
1371
|
+
/** Text Direction. Sets text direction (horizontal, rotated 90/270, stacked) in shapes in `ids` or the selection. Params: {ids?: [shape id], dir: horizontal|rotate90|rotate270|stacked, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1372
|
+
"format.direction": {
|
|
1373
|
+
dir?: "horizontal" | "rotate90" | "rotate270" | "stacked"; /** [shape id] */
|
|
1374
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1375
|
+
onSlide?: number;
|
|
1376
|
+
};
|
|
1377
|
+
/** Columns. Sets the number of text columns and their spacing in shapes in `ids` or the selection. Params: {ids?: [shape id], count, spacing?: pt, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1378
|
+
"format.columns": {
|
|
1379
|
+
count?: number; /** [shape id] */
|
|
1380
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1381
|
+
onSlide?: number; /** points */
|
|
1382
|
+
spacing?: number;
|
|
1383
|
+
};
|
|
1384
|
+
/** Autofit. Sets autofit: none, shrink text on overflow, or resize the shape to fit the text, for shapes in `ids` or the selection. Params: {ids?: [shape id], mode: none|shrink|resize, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1385
|
+
"format.autofit": {
|
|
1386
|
+
ids?: Array<Json>;
|
|
1387
|
+
mode?: "none" | "shrink" | "resize"; /** the slide the ids are on, from 1 */
|
|
1388
|
+
onSlide?: number;
|
|
1389
|
+
};
|
|
1390
|
+
/** Wrap Text in Shape. Turns text wrapping inside the shape on or off for shapes in `ids` or the selection. Params: {ids?: [shape id], on: bool, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1391
|
+
"format.wrap": {
|
|
1392
|
+
ids?: Array<Json>;
|
|
1393
|
+
on?: boolean; /** the slide the ids are on, from 1 */
|
|
1394
|
+
onSlide?: number;
|
|
1395
|
+
};
|
|
1396
|
+
/** Text Box Margins. Sets the text box margins in points for shapes in `ids` or the selection. Params: {ids?: [shape id], left?, top?, right?, bottom?: pt, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1397
|
+
"format.margins": {
|
|
1398
|
+
bottom?: number; /** [shape id] */
|
|
1399
|
+
ids?: Array<Json>;
|
|
1400
|
+
left?: number; /** the slide the ids are on, from 1 */
|
|
1401
|
+
onSlide?: number;
|
|
1402
|
+
right?: number;
|
|
1403
|
+
top?: number;
|
|
1404
|
+
};
|
|
1405
|
+
/** Format Painter. Picks up the formatting of the selected text or shape for `format.painterApply` (`sticky` keeps it for several applies). Params: {sticky?: bool}. Reads the selection, part. */
|
|
1406
|
+
"format.painter": {
|
|
1407
|
+
sticky?: boolean;
|
|
1408
|
+
};
|
|
1409
|
+
/** Paste Formatting. Applies the formatting picked up by `format.painter` to the shapes in `ids` or the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1410
|
+
"format.painterApply": {
|
|
1411
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1412
|
+
onSlide?: number;
|
|
1413
|
+
};
|
|
1414
|
+
/** Formatting State. Answers the effective formatting at the selection (font, size, bold, italic, alignment, bullets, ...), as the ribbon shows it. Params: {} ? the effective formatting at the selection (font, size, bold, ...). Reads the selection, part. */
|
|
1415
|
+
"format.state": Record<string, never>;
|
|
1416
|
+
/** Themes. Applies a theme by name (see `design.themes`) to the whole presentation. Params: {name} (see design.themes). Reads the part. Changes the document. */
|
|
1417
|
+
"design.theme": {
|
|
1418
|
+
name?: string;
|
|
1419
|
+
};
|
|
1420
|
+
/** Theme Gallery. Lists the themes, color schemes and font schemes the design commands take. Params: {} ? themes, colour schemes and font schemes. */
|
|
1421
|
+
"design.themes": Record<string, never>;
|
|
1422
|
+
/** Colors. Applies a color scheme by name, or sets theme colors (accent1..6, dk1, lt1, ...) directly, and answers the theme's scheme as {name, colors}; with no parameters it only reads it. Params: {name?, colors?: {accent1: #RRGGBB, ...} (slots dk1, lt1, dk2, lt2, accent1...accent6, hlink, folHlink)} ? {name, colors} (the theme's colour scheme after the change; {} only reads it). Reads the part. Changes the document. */
|
|
1423
|
+
"design.colors": {
|
|
1424
|
+
colors?: {
|
|
1425
|
+
accent1?: Json;
|
|
1426
|
+
};
|
|
1427
|
+
name?: string;
|
|
1428
|
+
};
|
|
1429
|
+
/** Fonts. Applies a font scheme by name, or sets the major (heading) and minor (body) fonts; the answer says when a font is missing. Params: {name} | {major, minor}. Reads the part. Changes the document. */
|
|
1430
|
+
"design.fonts": {
|
|
1431
|
+
major?: Json; /** in one of several forms of the parameters */
|
|
1432
|
+
minor?: Json; /** in one of several forms of the parameters */
|
|
1433
|
+
name?: string;
|
|
1434
|
+
};
|
|
1435
|
+
/** Format Background. Sets the background of the current slide to a color, gradient, picture or style, or resets it to the layout's; with `all` it is applied to all, as PowerPoint's Apply to All: the slide masters and layouts take it and the slides drop their own, so slides added later have it too. Params: {color?, gradient?, picture?: base64, pattern?: {preset, fg, bg}, style?: 1..12, reset?, all?: bool (Apply to All: the masters and layouts take it, so new slides do too), index?} (one of color, gradient, picture, pattern, style or reset). Reads the part. Changes the document. */
|
|
1436
|
+
"design.background": {
|
|
1437
|
+
all?: boolean;
|
|
1438
|
+
color?: string;
|
|
1439
|
+
gradient?: Json; /** a position counted from 0 (the first is 0) */
|
|
1440
|
+
index?: number; /** {preset, fg, bg} */
|
|
1441
|
+
pattern?: {
|
|
1442
|
+
bg?: Json;
|
|
1443
|
+
fg?: Json;
|
|
1444
|
+
preset?: string;
|
|
1445
|
+
}; /** base64 */
|
|
1446
|
+
picture?: Json;
|
|
1447
|
+
reset?: Json; /** 1 to 12 */
|
|
1448
|
+
style?: number;
|
|
1449
|
+
};
|
|
1450
|
+
/** Hide Background Graphics. Hides or shows the master's background graphics on the current slide. Params: {hide?: bool}. Reads the part. Changes the document. */
|
|
1451
|
+
"design.hideBackgroundGraphics": {
|
|
1452
|
+
hide?: boolean;
|
|
1453
|
+
};
|
|
1454
|
+
/** Slide Size. Sets the slide size by preset or width/height in points, scaling content to maximize or ensure fit. Params: {preset?: widescreen|standard|..., w?: pt, h?: pt (w and h instead of preset), scale?: maximize|ensureFit|none}. Changes the document. */
|
|
1455
|
+
"design.slideSize": {
|
|
1456
|
+
h?: number; /** widescreen, standard, a4, letter, ... */
|
|
1457
|
+
preset?: string;
|
|
1458
|
+
scale?: "maximize" | "ensureFit" | "none"; /** points */
|
|
1459
|
+
w?: number;
|
|
1460
|
+
};
|
|
1461
|
+
/** Header and Footer. Turns date, slide number and footer placeholders on or off (and sets their text) on the current or all slides. Params: {date?: bool, dateText?: fixed text, slideNumber?: bool, footer?: bool, footerText?, hideOnTitle?: bool, all?: bool (default true)}. Reads the part. Changes the document. */
|
|
1462
|
+
"design.headerFooter": {
|
|
1463
|
+
all?: boolean;
|
|
1464
|
+
date?: boolean; /** fixed date text */
|
|
1465
|
+
dateText?: string;
|
|
1466
|
+
footer?: boolean;
|
|
1467
|
+
footerText?: string;
|
|
1468
|
+
hideOnTitle?: boolean;
|
|
1469
|
+
slideNumber?: boolean;
|
|
1470
|
+
};
|
|
1471
|
+
/** Slide Master. Opens slide master view on a master or layout, so edits apply to it. Params: {master?: index, layout?: index|null (null selects the master itself)}. Reads the part. */
|
|
1472
|
+
"view.slideMaster": {
|
|
1473
|
+
layout?: Json; /** a position counted from 0 (the first is 0) */
|
|
1474
|
+
master?: number;
|
|
1475
|
+
};
|
|
1476
|
+
/** Close Master View. Leaves slide master view and goes back to the slides. Params: {}. */
|
|
1477
|
+
"view.closeMaster": Record<string, never>;
|
|
1478
|
+
/** Insert Layout. Adds a new layout to the current master in slide master view. Params: {name?}. Reads the part. Changes the document. */
|
|
1479
|
+
"master.insertLayout": {
|
|
1480
|
+
name?: string;
|
|
1481
|
+
};
|
|
1482
|
+
/** Rename Layout. Renames a layout of a master. Params: {name, master?, layout?}. Reads the part. Changes the document. */
|
|
1483
|
+
"master.renameLayout": {
|
|
1484
|
+
layout?: number; /** master (from 0) */
|
|
1485
|
+
master?: number;
|
|
1486
|
+
name?: string;
|
|
1487
|
+
};
|
|
1488
|
+
/** Delete Layout. Deletes a layout from a master; slides using it move to another layout. Params: {master?, layout?}. Reads the part. Changes the document. */
|
|
1489
|
+
"master.deleteLayout": {
|
|
1490
|
+
layout?: number; /** master (from 0) */
|
|
1491
|
+
master?: number;
|
|
1492
|
+
};
|
|
1493
|
+
/** Insert Placeholder. Inserts a placeholder (content, text, picture, chart, table, media) on the layout being edited in slide master view. Params: {kind: content|text|picture|chart|table|media, rect?: [x,y,w,h]}. Reads the part. Changes the document. */
|
|
1494
|
+
"master.insertPlaceholder": {
|
|
1495
|
+
kind?: "content" | "text" | "picture" | "chart" | "table" | "media";
|
|
1496
|
+
rect?: Array<number>;
|
|
1497
|
+
};
|
|
1498
|
+
/** Transition. Sets the transition into slide `index` (from 0, else the current slide): none, morph, fade, push, wipe, .... Params: {kind: none|morph|fade|push|wipe|split|reveal|cut|randomBar|shape|uncover|cover|flash|... (transition.list), option?, duration?: ms, index?}. Reads the selection, part. Changes the document. */
|
|
1499
|
+
"transition.set": {
|
|
1500
|
+
duration?: number; /** a position counted from 0 (the first is 0) */
|
|
1501
|
+
index?: number; /** the transition: none, morph, fade, push, wipe, split, reveal, cut, randomBar, shape, uncover, cover, flash, ... (transition.list) */
|
|
1502
|
+
kind?: string; /** an effect option the transition offers (transition.list) */
|
|
1503
|
+
option?: string;
|
|
1504
|
+
};
|
|
1505
|
+
/** Effect Options. Sets the transition's effect option (such as the direction) on slide `index` or the current slide. Params: {option, index?}. Reads the selection, part. Changes the document. */
|
|
1506
|
+
"transition.options": {
|
|
1507
|
+
index?: number; /** an effect option the transition offers (transition.list) */
|
|
1508
|
+
option?: string;
|
|
1509
|
+
};
|
|
1510
|
+
/** Timing. Sets transition duration, advance on click and automatic advance after a time on slide `index` or the current slide. Params: {duration?: ms, onClick?: bool, after?: ms | null, index?}. Reads the selection, part. Changes the document. */
|
|
1511
|
+
"transition.timing": {
|
|
1512
|
+
after?: Json; /** milliseconds */
|
|
1513
|
+
duration?: number; /** a position counted from 0 (the first is 0) */
|
|
1514
|
+
index?: number;
|
|
1515
|
+
onClick?: boolean;
|
|
1516
|
+
};
|
|
1517
|
+
/** Apply To All. Applies the current slide's transition and timing to every slide. Params: {}. Reads the part. Changes the document. */
|
|
1518
|
+
"transition.applyAll": Record<string, never>;
|
|
1519
|
+
/** Transition Gallery. Lists the transitions `transition.set` takes, with category, default duration and effect options. Params: {, onSlide?: int (the slide the ids are on, from 1)} ? [{id, label, category, duration, options}]. */
|
|
1520
|
+
"transition.list": {
|
|
1521
|
+
onSlide?: number;
|
|
1522
|
+
};
|
|
1523
|
+
/** Animation Styles. Replaces the animations of shapes in `ids` or the selection with one effect (see `animation.list`); a `customPath` motion path goes through `points` ([[dx, dy]] in points from the shape's place), straight or `smooth`, open or `closed`. Params: {effect: fade|fly|zoom|wipe|appear|spin|pulse|fadeOut|lines|... (animation.list), class?: entrance|emphasis|exit|path, option?, start?: onClick|withPrevious|afterPrevious, duration?: ms, delay?: ms, points?: [[dx, dy]] (customPath: where the path goes, in points from the shape's place), smooth?: bool (customPath: a curve through the points), closed?: bool (customPath: back to the start), ids?, onSlide?: int (the slide the ids are on, from 1)} ? replaces the shapes' animations. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1524
|
+
"animation.set": {
|
|
1525
|
+
class?: "entrance" | "emphasis" | "exit" | "path"; /** customPath: back to the start */
|
|
1526
|
+
closed?: boolean; /** milliseconds */
|
|
1527
|
+
delay?: number; /** milliseconds */
|
|
1528
|
+
duration?: number; /** an effect id from animation.list: fade, fly, zoom, wipe, appear, spin, pulse, ... */
|
|
1529
|
+
effect?: string;
|
|
1530
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1531
|
+
onSlide?: number; /** an effect option from animation.list */
|
|
1532
|
+
option?: string; /** customPath: where the path goes, in points from the shape's place */
|
|
1533
|
+
points?: Array<Array<number>>; /** customPath: a curve through the points */
|
|
1534
|
+
smooth?: boolean;
|
|
1535
|
+
start?: "onClick" | "withPrevious" | "afterPrevious";
|
|
1536
|
+
};
|
|
1537
|
+
/** Add Animation. Adds an animation effect to shapes in `ids` or the selection, after their existing ones, with start, duration and delay; a `customPath` motion path goes through `points` ([[dx, dy]] in points from the shape's place). Params: {effect, class?, option?, start?: onClick|withPrevious|afterPrevious, duration?: ms, delay?: ms, points?: [[dx, dy]] (customPath: where the path goes, in points from the shape's place), smooth?: bool, closed?: bool, ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1538
|
+
"animation.add": {
|
|
1539
|
+
class?: "entrance" | "emphasis" | "exit" | "path";
|
|
1540
|
+
closed?: boolean; /** milliseconds */
|
|
1541
|
+
delay?: number; /** milliseconds */
|
|
1542
|
+
duration?: number; /** an effect id from animation.list */
|
|
1543
|
+
effect?: string;
|
|
1544
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1545
|
+
onSlide?: number; /** an effect option from animation.list */
|
|
1546
|
+
option?: string; /** customPath: where the path goes, in points from the shape's place */
|
|
1547
|
+
points?: Array<Array<number>>;
|
|
1548
|
+
smooth?: boolean;
|
|
1549
|
+
start?: "onClick" | "withPrevious" | "afterPrevious";
|
|
1550
|
+
};
|
|
1551
|
+
/** Remove Animation. Removes animation `index` on the slide, or all animations of shapes in `ids`. Params: {index, onSlide?: int (the slide the ids are on, from 1)} | {ids?} (all of the shapes' animations). Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1552
|
+
"animation.remove": {
|
|
1553
|
+
ids?: Array<Json>; /** a position counted from 0 (the first is 0); in one of several forms of the parameters */
|
|
1554
|
+
index?: number; /** the slide the ids are on, from 1; in one of several forms of the parameters */
|
|
1555
|
+
onSlide?: number;
|
|
1556
|
+
};
|
|
1557
|
+
/** Reorder Animation. Moves animation `index` to position `to` in the slide's animation order. Params: {index, to}. Reads the part. Changes the document. */
|
|
1558
|
+
"animation.move": {
|
|
1559
|
+
index?: number; /** the animation position (from 0) */
|
|
1560
|
+
to?: number;
|
|
1561
|
+
};
|
|
1562
|
+
/** Timing. Sets start (on click, with or after previous), duration and delay of animation `index` or the selected shapes' animations. Params: {index? (else selected shapes), start?: onClick|withPrevious|afterPrevious, duration?: ms, delay?: ms, repeat?: n, rewind?: bool, trigger?: shape id | null}. Reads the selection, part. Changes the document. */
|
|
1563
|
+
"animation.timing": {
|
|
1564
|
+
delay?: number; /** milliseconds */
|
|
1565
|
+
duration?: number; /** a position counted from 0 (the first is 0); else selected shapes */
|
|
1566
|
+
index?: number;
|
|
1567
|
+
repeat?: number;
|
|
1568
|
+
rewind?: boolean;
|
|
1569
|
+
start?: "onClick" | "withPrevious" | "afterPrevious"; /** start on a click on this shape; null for the slide's click order */
|
|
1570
|
+
trigger?: Json;
|
|
1571
|
+
};
|
|
1572
|
+
/** Effect Options. Sets an animation's effect option and text build (as one, by paragraph, word or letter). Params: {option?, textBuild?: asOne|byParagraph|byWord|byLetter, index?}. Reads the selection, part. Changes the document. */
|
|
1573
|
+
"animation.options": {
|
|
1574
|
+
index?: number; /** an effect option from animation.list */
|
|
1575
|
+
option?: string;
|
|
1576
|
+
textBuild?: "asOne" | "byParagraph" | "byWord" | "byLetter";
|
|
1577
|
+
};
|
|
1578
|
+
/** Remove All Animations. Removes every animation from slide `index` or the current slide. Params: {index?: slide}. Reads the part. Changes the document. */
|
|
1579
|
+
"animation.clear": {
|
|
1580
|
+
index?: number;
|
|
1581
|
+
};
|
|
1582
|
+
/** Animation Painter. Picks up the animations of a shape for `animation.painterApply`. Params: {sticky?: bool, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. */
|
|
1583
|
+
"animation.painter": {
|
|
1584
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1585
|
+
onSlide?: number;
|
|
1586
|
+
sticky?: boolean;
|
|
1587
|
+
};
|
|
1588
|
+
/** Apply Animation. Applies the animations picked up by `animation.painter` to shapes in `ids` or the selection. Params: {ids?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `ids`. Reads the selection, part. Changes the document. */
|
|
1589
|
+
"animation.painterApply": {
|
|
1590
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1591
|
+
onSlide?: number;
|
|
1592
|
+
};
|
|
1593
|
+
/** Animation Gallery. Lists the animation effects the animation commands take, with class (entrance, emphasis, exit, path) and options. Params: {, onSlide?: int (the slide the ids are on, from 1)} ? [{id, label, class, options}]. */
|
|
1594
|
+
"animation.list": {
|
|
1595
|
+
onSlide?: number;
|
|
1596
|
+
};
|
|
1597
|
+
/** Animations on Slide. Answers the animations on slide `slide` (from 0, else the current slide) in playing order. Params: {slide?} ? [animation]. Reads the part. */
|
|
1598
|
+
"animation.get": {
|
|
1599
|
+
slide?: number;
|
|
1600
|
+
};
|
|
1601
|
+
/** Inspect Table Selection. Answers the selected or named table's selected cells, rows, columns and style options, or null when no table is selected. Params: {id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. */
|
|
1602
|
+
"table.state": {
|
|
1603
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1604
|
+
onSlide?: number;
|
|
1605
|
+
};
|
|
1606
|
+
/** Cell Formatting. Sets cell anchor, margins and borders of the selected (or given) cells of a table. Params: {anchor?: top|center|bottom, margins?: [left,right,top,bottom], border?: none | edges of table.border, color?, width?: pt, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1607
|
+
"table.cellFormat": {
|
|
1608
|
+
anchor?: "top" | "center" | "bottom"; /** none | edges of table.border */
|
|
1609
|
+
border?: Json;
|
|
1610
|
+
color?: string; /** an id */
|
|
1611
|
+
id?: Json; /** [left, right, top, bottom] */
|
|
1612
|
+
margins?: Array<number>; /** the slide the ids are on, from 1 */
|
|
1613
|
+
onSlide?: number; /** points */
|
|
1614
|
+
width?: number;
|
|
1615
|
+
};
|
|
1616
|
+
/** Borders. Sets borders on edges (all, outside, inside, top, ...) of the selected or given cells of a table. Params: {edges: all|outside|inside|top|bottom|left|right|insideH|insideV|diagDown|diagUp, color?, width?: pt (0.25?24), none?: bool, from?: [r,c], to?: [r,c], id?, onSlide?: int (the slide the ids are on, from 1)} (default range: selected cells, else the whole table). Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1617
|
+
"table.border": {
|
|
1618
|
+
color?: string;
|
|
1619
|
+
edges?: "all" | "outside" | "inside" | "top" | "bottom" | "left" | "right" | "insideH" | "insideV" | "diagDown" | "diagUp"; /** [r, c] */
|
|
1620
|
+
from?: Array<number>; /** an id */
|
|
1621
|
+
id?: Json;
|
|
1622
|
+
none?: boolean; /** the slide the ids are on, from 1 */
|
|
1623
|
+
onSlide?: number; /** [r, c] */
|
|
1624
|
+
to?: Array<number>; /** points; 0.25?24 */
|
|
1625
|
+
width?: number;
|
|
1626
|
+
};
|
|
1627
|
+
/** Clear Cells. Clears the text of the given (else selected) cells of a table. Params: {cells?: [[r,c],...], id?, onSlide?: int (the slide the ids are on, from 1)} (default: selected cells). Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1628
|
+
"table.clearCells": {
|
|
1629
|
+
cells?: Array<Array<number>>; /** an id */
|
|
1630
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1631
|
+
onSlide?: number;
|
|
1632
|
+
};
|
|
1633
|
+
/** Insert Above. Inserts a row above row `row` (from 0, else the selected row) of the table `id` or the selected table. Params: {row?, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1634
|
+
"table.insertRowAbove": {
|
|
1635
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1636
|
+
onSlide?: number;
|
|
1637
|
+
row?: number;
|
|
1638
|
+
};
|
|
1639
|
+
/** Insert Below. Inserts a row below row `row` (from 0, else the selected row) of the table. Params: {row?, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1640
|
+
"table.insertRowBelow": {
|
|
1641
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1642
|
+
onSlide?: number;
|
|
1643
|
+
row?: number;
|
|
1644
|
+
};
|
|
1645
|
+
/** Insert Left. Inserts a column left of column `col` (from 0, else the selected column) of the table. Params: {col?, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1646
|
+
"table.insertColumnLeft": {
|
|
1647
|
+
col?: number; /** an id */
|
|
1648
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1649
|
+
onSlide?: number;
|
|
1650
|
+
};
|
|
1651
|
+
/** Insert Right. Inserts a column right of column `col` (from 0, else the selected column) of the table. Params: {col?, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1652
|
+
"table.insertColumnRight": {
|
|
1653
|
+
col?: number; /** an id */
|
|
1654
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1655
|
+
onSlide?: number;
|
|
1656
|
+
};
|
|
1657
|
+
/** Delete Rows. Deletes row `row` (from 0, else the selected rows) of the table. Params: {row?, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1658
|
+
"table.deleteRow": {
|
|
1659
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1660
|
+
onSlide?: number;
|
|
1661
|
+
row?: number;
|
|
1662
|
+
};
|
|
1663
|
+
/** Delete Columns. Deletes column `col` (from 0, else the selected columns) of the table. Params: {col?, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1664
|
+
"table.deleteColumn": {
|
|
1665
|
+
col?: number; /** an id */
|
|
1666
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1667
|
+
onSlide?: number;
|
|
1668
|
+
};
|
|
1669
|
+
/** Merge Cells. Merges the cells from [row, col] `from` to `to` (from 0) into one cell. Params: {from: [r, c], to: [r, c], id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1670
|
+
"table.merge": {
|
|
1671
|
+
from?: Array<number>; /** an id */
|
|
1672
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1673
|
+
onSlide?: number; /** [r, c] */
|
|
1674
|
+
to?: Array<number>;
|
|
1675
|
+
};
|
|
1676
|
+
/** Split Cells. Splits a merged cell at [row, col] back into its cells. Params: {cell: [r, c], id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1677
|
+
"table.split": {
|
|
1678
|
+
cell?: Array<number>; /** an id */
|
|
1679
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1680
|
+
onSlide?: number;
|
|
1681
|
+
};
|
|
1682
|
+
/** Table Styles. Applies a table style (medium2-accent1, light1-accent2, grid, none, ...) to the table. Params: {style: medium2-accent1|light1-accent2|dark1-tx1|grid|none..., id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1683
|
+
"table.style": {
|
|
1684
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1685
|
+
onSlide?: number; /** a table style: medium2-accent1, light1-accent2, dark1-tx1, grid, none, ... */
|
|
1686
|
+
style?: string;
|
|
1687
|
+
};
|
|
1688
|
+
/** Table Style Options. Turns table style options on or off: header row, total row, banded rows, first/last column, banded columns. Params: {headerRow?, totalRow?, bandedRows?, firstColumn?, lastColumn?, bandedColumns?: bool, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1689
|
+
"table.options": {
|
|
1690
|
+
bandedColumns?: boolean;
|
|
1691
|
+
bandedRows?: boolean;
|
|
1692
|
+
firstColumn?: boolean;
|
|
1693
|
+
headerRow?: boolean; /** an id */
|
|
1694
|
+
id?: Json;
|
|
1695
|
+
lastColumn?: boolean; /** the slide the ids are on, from 1 */
|
|
1696
|
+
onSlide?: number;
|
|
1697
|
+
totalRow?: boolean;
|
|
1698
|
+
};
|
|
1699
|
+
/** Shading. Sets the shading color (or none) of the given, selected or all cells of a table. Params: {color? | none?, cells?: [[r,c],...] (default: selected cells or all), id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1700
|
+
"table.cellFill": {
|
|
1701
|
+
cells?: Array<Array<number>>; /** one of several alternative parameters */
|
|
1702
|
+
color?: string; /** an id */
|
|
1703
|
+
id?: Json; /** one of several alternative parameters */
|
|
1704
|
+
none?: Json; /** the slide the ids are on, from 1 */
|
|
1705
|
+
onSlide?: number;
|
|
1706
|
+
};
|
|
1707
|
+
/** Distribute Rows. Makes the table's rows the same height. Params: {id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1708
|
+
"table.distributeRows": {
|
|
1709
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1710
|
+
onSlide?: number;
|
|
1711
|
+
};
|
|
1712
|
+
/** Distribute Columns. Makes the table's columns the same width. Params: {id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1713
|
+
"table.distributeColumns": {
|
|
1714
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1715
|
+
onSlide?: number;
|
|
1716
|
+
};
|
|
1717
|
+
/** Width. Sets the width in points of column `col` (from 0) of the table. Params: {col, width: pt, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1718
|
+
"table.columnWidth": {
|
|
1719
|
+
col?: number; /** an id */
|
|
1720
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1721
|
+
onSlide?: number; /** points */
|
|
1722
|
+
width?: number;
|
|
1723
|
+
};
|
|
1724
|
+
/** Height. Sets the height in points of row `row` (from 0) of the table. Params: {row, height: pt, id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1725
|
+
"table.rowHeight": {
|
|
1726
|
+
height?: number; /** an id */
|
|
1727
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1728
|
+
onSlide?: number;
|
|
1729
|
+
row?: number;
|
|
1730
|
+
};
|
|
1731
|
+
/** Select Cells. Selects table cells from [row, col] `from` to `to` (from 0) for cell commands. Params: {from: [r,c], to: [r,c], id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. */
|
|
1732
|
+
"table.selectCells": {
|
|
1733
|
+
from?: Array<number>; /** an id */
|
|
1734
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1735
|
+
onSlide?: number; /** [r, c] */
|
|
1736
|
+
to?: Array<number>;
|
|
1737
|
+
};
|
|
1738
|
+
/** New Comment. Adds a comment with `text` on slide `slide` (from 0, else the current one), anchored to shape `id` or a point, and answers the thread. Params: {text, slide?: index, id?: shape, x?, y?, author?: principal, name?, created?, onSlide?: int (the slide the ids are on, from 1)} ? {index, thread}. Reads the selection, part. Changes the document. */
|
|
1739
|
+
"comment.add": {
|
|
1740
|
+
author?: string; /** ISO 8601 time */
|
|
1741
|
+
created?: string; /** a shape id (number, number string or KitDrawing id) */
|
|
1742
|
+
id?: Json;
|
|
1743
|
+
name?: string; /** the slide the ids are on, from 1 */
|
|
1744
|
+
onSlide?: number; /** a position counted from 0 (the first is 0) */
|
|
1745
|
+
slide?: number;
|
|
1746
|
+
text?: string;
|
|
1747
|
+
x?: number;
|
|
1748
|
+
y?: number;
|
|
1749
|
+
};
|
|
1750
|
+
/** Reply. Adds a reply to comment thread `thread` (or the `index`-th thread) and answers the comment. Params: {thread | index, text, author?, name?, created?} ? {comment}. Reads the part. Changes the document. */
|
|
1751
|
+
"comment.reply": {
|
|
1752
|
+
author?: string; /** ISO 8601 time */
|
|
1753
|
+
created?: string; /** a position counted from 0 (the first is 0); one of several alternative parameters */
|
|
1754
|
+
index?: number;
|
|
1755
|
+
name?: string;
|
|
1756
|
+
text?: string; /** one of several alternative parameters */
|
|
1757
|
+
thread?: Json;
|
|
1758
|
+
};
|
|
1759
|
+
/** Delete Comment. Deletes a comment, a whole thread, or all comments with `all: true`. Params: {thread, comment?} | {index?} | {all: true}. Reads the part. Changes the document. */
|
|
1760
|
+
"comment.delete": {
|
|
1761
|
+
all?: boolean; /** one comment's id; without it the whole thread */
|
|
1762
|
+
comment?: string; /** a position counted from 0 (the first is 0); in one of several forms of the parameters */
|
|
1763
|
+
index?: number; /** the thread id */
|
|
1764
|
+
thread?: string;
|
|
1765
|
+
};
|
|
1766
|
+
/** Resolve Thread. Marks comment thread `thread` resolved, or open again with `resolved: false`. Params: {thread | index, resolved?: bool}. Reads the part. Changes the document. */
|
|
1767
|
+
"comment.resolve": {
|
|
1768
|
+
index?: number;
|
|
1769
|
+
resolved?: boolean; /** one of several alternative parameters */
|
|
1770
|
+
thread?: Json;
|
|
1771
|
+
};
|
|
1772
|
+
/** Comments. Lists the comments on slide `slide` (from 0) or on every slide. Params: {slide?} ? comments. Reads the part. */
|
|
1773
|
+
"comment.list": {
|
|
1774
|
+
slide?: number;
|
|
1775
|
+
};
|
|
1776
|
+
/** Comment Threads. Lists the comment threads with their slide, anchor object, comments and resolved state. Params: {, onSlide?: int (the slide the ids are on, from 1)} ? [{id, slide, anchor: {object, slide, x, y, shape?, box?}, resolved, comments: [{id, author, name, body, created}]}]. Reads the part. */
|
|
1777
|
+
"comment.threads": {
|
|
1778
|
+
onSlide?: number;
|
|
1779
|
+
};
|
|
1780
|
+
/** Check Accessibility. Lists accessibility issues (missing slide titles, missing alt text, reading order) by slide and shape. Params: {} ? [{slide, shape, issue}]. */
|
|
1781
|
+
"review.accessibility": Record<string, never>;
|
|
1782
|
+
/** Spelling. Lists the words not in the built-in word list, by slide and shape. Params: {} ? [{slide, shape, word}] (words not in the built-in list). */
|
|
1783
|
+
"review.spelling": Record<string, never>;
|
|
1784
|
+
/** Play from Start. Starts the slide show from the first slide. Params: {}. */
|
|
1785
|
+
"show.fromStart": Record<string, never>;
|
|
1786
|
+
/** Play from Current Slide. Starts the slide show from the current slide. Params: {}. Reads the part. */
|
|
1787
|
+
"show.fromCurrent": Record<string, never>;
|
|
1788
|
+
/** Set Up Slide Show. Sets slide show options: presenter or kiosk mode, looping, narration, animations, timings and slide range. Params: {type?: speaker|browsed|kiosk, loop?: bool, noNarration?, noAnimation?, useTimings?, from?, to?, all?: bool (every slide, instead of from and to)}. Changes the document. */
|
|
1789
|
+
"show.setup": {
|
|
1790
|
+
all?: boolean; /** first slide (from 1) */
|
|
1791
|
+
from?: number;
|
|
1792
|
+
loop?: boolean;
|
|
1793
|
+
noAnimation?: boolean;
|
|
1794
|
+
noNarration?: boolean; /** last slide (from 1) */
|
|
1795
|
+
to?: number;
|
|
1796
|
+
type?: "speaker" | "browsed" | "kiosk";
|
|
1797
|
+
useTimings?: boolean;
|
|
1798
|
+
};
|
|
1799
|
+
/** Custom Slide Show. Creates or replaces a custom show named `name` from slide indexes (from 0), or deletes it. Params: {name, slides: [index]} | {name, delete: true}. Changes the document. */
|
|
1800
|
+
"show.customShow": {
|
|
1801
|
+
delete?: boolean; /** in one of several forms of the parameters */
|
|
1802
|
+
name?: string; /** in one of several forms of the parameters */
|
|
1803
|
+
slides?: Array<number>;
|
|
1804
|
+
};
|
|
1805
|
+
/** Inspect slide. Answers the presentation: slides with ids, titles, layouts and shape counts, the current slide and selection, slide size, theme and fonts. Start here. Params: {} ? slides with titles, layouts, shape counts; selection; size; theme. */
|
|
1806
|
+
"document.inspect": Record<string, never>;
|
|
1807
|
+
/** Inspect Slide. Answers one slide (`index` from 0, else the current one): its shapes with ids, kinds, boxes, text and fills (a group's children with their boxes on the slide), plus animations, transition, notes and comments. An agent's read leaves the current slide and the selection as they were: name the slide in later calls (`onSlide`, or the run's `target` or a step's `at.part`). Params: {index?, select?: bool (false: a person's read leaves the current slide; an agent's read always does)} ? the slide's shapes with ids, kinds, boxes, text, fills, animations, transition, notes. Reads the part. */
|
|
1808
|
+
"slide.inspect": {
|
|
1809
|
+
index?: number; /** false: a person's read leaves the current slide; an agent's read always does */
|
|
1810
|
+
select?: boolean;
|
|
1811
|
+
};
|
|
1812
|
+
/** Inspect Shape. Answers the full properties of shape `id` (on slide `onSlide`, from 1) with its effective formatting. Params: {id, onSlide?: int (the slide the ids are on, from 1)} ? full shape JSON plus its effective box. Acts on `id`. Reads the selection, part. */
|
|
1813
|
+
"shape.inspect": {
|
|
1814
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1815
|
+
onSlide?: number;
|
|
1816
|
+
};
|
|
1817
|
+
/** List Commands. Lists the kit's commands with labels, parameters and whether they are enabled, filtered by a substring. Params: {filter?: substring, onSlide?: int (the slide the ids are on, from 1)} ? [{id, label, params, enabled}]. */
|
|
1818
|
+
"commands.list": {
|
|
1819
|
+
filter?: string; /** the slide the ids are on, from 1 */
|
|
1820
|
+
onSlide?: number;
|
|
1821
|
+
};
|
|
1822
|
+
/** Play. Plays the audio or video `id` (else the one on the slide) in the editor, from `from` milliseconds. Params: {id?, from?: ms, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. */
|
|
1823
|
+
"media.play": {
|
|
1824
|
+
from?: number; /** an id */
|
|
1825
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1826
|
+
onSlide?: number;
|
|
1827
|
+
};
|
|
1828
|
+
/** Pause. Pauses the audio or video `id` (else the one on the slide) in the editor. Params: {id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. */
|
|
1829
|
+
"media.pause": {
|
|
1830
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1831
|
+
onSlide?: number;
|
|
1832
|
+
};
|
|
1833
|
+
/** Play/Pause. Plays or pauses the audio or video `id` (else the one on the slide) in the editor. Params: {id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. */
|
|
1834
|
+
"media.toggle": {
|
|
1835
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1836
|
+
onSlide?: number;
|
|
1837
|
+
};
|
|
1838
|
+
/** Stop. Stops the audio or video `id` (else the one on the slide) and rewinds it. Params: {id?, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. */
|
|
1839
|
+
"media.stop": {
|
|
1840
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1841
|
+
onSlide?: number;
|
|
1842
|
+
};
|
|
1843
|
+
/** Seek. Moves the playback position of the audio or video `id` to `ms` milliseconds. Params: {id?, ms, onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. */
|
|
1844
|
+
"media.seek": {
|
|
1845
|
+
id?: Json; /** milliseconds from the start */
|
|
1846
|
+
ms?: number; /** the slide the ids are on, from 1 */
|
|
1847
|
+
onSlide?: number;
|
|
1848
|
+
};
|
|
1849
|
+
/** Media Info. Answers the audio or video `id` (else the one on the slide): name, content type, size, duration and playback options. Params: {id?, onSlide?: int (the slide the ids are on, from 1)} ? {id, name, contentType, bytes, durationMs, video, width, height, probe: {container, audio?, video?}, options, status?}. Acts on `id`. Reads the selection, part. */
|
|
1850
|
+
"media.info": {
|
|
1851
|
+
id?: Json; /** the slide the ids are on, from 1 */
|
|
1852
|
+
onSlide?: number;
|
|
1853
|
+
};
|
|
1854
|
+
/** Poster Frame. Sets the video's poster frame to the frame at `ms` (else the current position). Params: {id?, ms?: frame time (default: current position), onSlide?: int (the slide the ids are on, from 1)}. Acts on `id`. Reads the selection, part. Changes the document. */
|
|
1855
|
+
"media.posterFrame": {
|
|
1856
|
+
id?: Json; /** frame time in milliseconds; default: the current position */
|
|
1857
|
+
ms?: number; /** the slide the ids are on, from 1 */
|
|
1858
|
+
onSlide?: number;
|
|
1859
|
+
};
|
|
1860
|
+
/** Play/Pause GIF. Plays or pauses the animated GIF `id` (else the one on the slide) in the editor. Params: {id?, ids? (the first is played, instead of id), play?: bool (default: toggle), onSlide?: int (the slide the ids are on, from 1)} ? {id, playing}. Acts on `ids`. Reads the selection, part. */
|
|
1861
|
+
"media.gifPlay": {
|
|
1862
|
+
id?: Json; /** the first is played, instead of id */
|
|
1863
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1864
|
+
onSlide?: number; /** default: toggle */
|
|
1865
|
+
play?: boolean;
|
|
1866
|
+
};
|
|
1867
|
+
/** Selection for Presence. Answers the selection in the form collaborators' presence shows it (slide and objects). Params: {, onSlide?: int (the slide the ids are on, from 1)} ? {slide: object | null, objects: [object]} (the current slide's and the selected shapes' KDM object ids; none before the document has a replica). Reads the part. */
|
|
1868
|
+
"presence.selection": {
|
|
1869
|
+
onSlide?: number;
|
|
1870
|
+
};
|
|
1871
|
+
/** Locate Objects. Answers where the objects in `ids` are drawn (x, y, width, height), for showing collaborators' cursors. Params: {ids: [object], onSlide?: int (the slide the ids are on, from 1)} ? [{id, x, y, width, height}] (the shapes of the current slide among ids, in slide points). Acts on `ids`. Reads the part. */
|
|
1872
|
+
"presence.locate": {
|
|
1873
|
+
ids?: Array<Json>; /** the slide the ids are on, from 1 */
|
|
1874
|
+
onSlide?: number;
|
|
1875
|
+
};
|
|
1876
|
+
/** Comment Anchor. Answers the selected text, shapes, or point (`x`, `y`), else the current slide, as a comment anchor of object ids for a host that keeps comment threads. Params: {x?, y?: slide points, onSlide?: int (the slide the ids are on, from 1)} ? {ids, range?, quote?, page} | null (the selected text or shapes as a comment anchor, else the point, else the current slide; makes the replica if there is none; null outside the slides). Reads the selection, part. */
|
|
1877
|
+
"comment.anchor": {
|
|
1878
|
+
onSlide?: number;
|
|
1879
|
+
x?: number; /** a point on the slide, in points from its top */
|
|
1880
|
+
y?: number;
|
|
1881
|
+
};
|
|
1882
|
+
/** Place Comment Anchors. Answers where each comment anchor in `anchors` is now: whether its object is found, its slide, and its shape's box or point (in points). Params: {anchors: [{ids, range?}], onSlide?: int (the slide the ids are on, from 1)} ? [{found, slide: index | null, rect: {x, y, width, height} | null, point: {x, y} | null}] (found: the first id still exists; slide and rect where its marker goes now, in slide points; nothing is found before the document has a replica, and placing never makes one). Reads the part. */
|
|
1883
|
+
"comment.place": {
|
|
1884
|
+
anchors?: Array<{
|
|
1885
|
+
ids?: Array<Json>;
|
|
1886
|
+
range?: Json;
|
|
1887
|
+
}>; /** the slide the ids are on, from 1 */
|
|
1888
|
+
onSlide?: number;
|
|
1889
|
+
};
|
|
1890
|
+
}
|
|
1891
|
+
/** A Slide file opened with `openDocument<SlideFile, SlideCommands>`. */
|
|
1892
|
+
export type SlideDocument = ModelDocument<SlideFile, SlideCommands>;
|
|
1893
|
+
export type SlideContext = RequestContext<SlideFile, SlideCommands>;
|
|
1894
|
+
export {};
|