ts-pptx

Appearance

Interface: SlideObjectInfo ​

One authored object on a slide, as Slide.objects reports it: what it is and how it is addressed, not how it is drawn. It is a snapshot taken when the getter ran, not a live handle — nothing on it writes back, and a later addShape/groupObjects leaves it describing the slide as it was.

The point of it is composition. A slide assembled by independent renderers arrives with objects whose descriptors nobody kept, and the only durable handle on them is the objectName each one was authored with; without a way to enumerate those, a consumer that wants to act on what is already there has to either make every renderer surrender its internals or keep a parallel ledger of what it added — and a ledger is wrong the moment a renderer adds an object it did not announce.

Properties ​

canGroup ​

readonly canGroup: boolean

Whether groupObjects() would accept this object on kind alone. It cannot speak for the selection — an unresolved, duplicated or ambiguous name still throws — so it answers "is this object groupable", never "will this call succeed".

children ​

readonly children: readonly SlideObjectInfo[]

Children, when type is group; empty otherwise. Ordered bottom-to-top like Slide.objects itself, and nested to whatever depth the groups nest.

isPlaceholder ​

readonly isPlaceholder: boolean

True when the object occupies a layout placeholder, which grouping refuses on top of kind.

objectName ​

readonly objectName: string

Selection Pane name, in the spelling the caller passed to objectName, so it can be handed straight back to groupObjects() or to an animation or connector reference.

Always a string: an object authored without a name still gets the generated Shape 3 / Text 1 / Group 2 identity PowerPoint shows in the Selection Pane, and that name addresses it just as well. The two are indistinguishable here on purpose — nothing downstream of authoring records which is which, and a consumer that cares can tell them apart by the naming convention it chose for its own objects.

type ​

readonly type: SlideObjectType

What kind of object this is — the same value the object was authored as.