Class: NotesPlaceholder
One placeholder shape (p:sp) of a notes slide. A notes slide holds a fixed set: the slide thumbnail (type="sldImg"), the notes body (type="body"), and the slide number (type="sldNum"). Geometry getters read the placeholder's owna:xfrm and are null when it inherits geometry from the notesMaster (the case on an authored deck, whose sldImg/sldNum carry an empty p:spPr).
A notes placeholder IS a Placeholder. Identity, geometry and the escape hatch are the same twelve members read off the same p:sp, down to p:ph being found the same way, so it extends one rather than repeating it. Two things are its own: the flattened text convenience, and a textFrame that threads the notesMaster inheritance context onto the body frame.
Extends
Constructors
Constructor
new NotesPlaceholder(
sp,host):NotesPlaceholder
Parameters
| Parameter | Type | Description |
|---|---|---|
sp | Element | The placeholder's p:sp. protected so NotesPlaceholder can read it. |
host | ShapeHost | The part the p:sp lives in: a master, a layout, or a notes slide. |
Returns
NotesPlaceholder
Inherited from
Accessors
element_
Get Signature
get element_():
Element
Escape hatch: the underlying p:sp element. After mutating it call markDirty, or save() writes the original bytes.
Returns
Element
Inherited from
height
Get Signature
get height():
number|null
Height in EMU (a:ext/@cy), or null when the placeholder carries no own a:xfrm.
Returns
number | null
Inherited from
id
Get Signature
get id():
number|null
Drawing id (p:cNvPr/@id), or null when absent.
Returns
number | null
Inherited from
idx
Get Signature
get idx():
string|null
Placeholder index (p:ph/@idx), or null when unset.
Not forwarded to AutoShape.placeholder, whose idx defaults to '0' the way PowerPoint resolves it. Here the absence is the contract: this view reports what the part says.
Returns
string | null
Inherited from
left
Get Signature
get left():
number|null
Left edge in EMU (a:off/@x), or null when the placeholder carries no own a:xfrm.
Returns
number | null
Inherited from
name
Get Signature
get name():
string
Shape name (p:cNvPr/@name), or '' when unnamed.
Returns
string
Inherited from
text
Get Signature
get text():
string
The placeholder's flattened text (paragraphs joined by \n), or '' when it has no text body.
Returns
string
textFrame
Get Signature
get textFrame():
TextFrame|null
The placeholder's text as a navigable TextFrame (p:txBody), or null when it carries no text body (the sldImg thumbnail). The body placeholder's runs round-trip a slide's authored notes; the sldNum placeholder's frame holds the slide-number a:fld, whose value surfaces through TextFrame.text.
Overrides Placeholder.textFrame for the inheritance context alone (see below).
Returns
TextFrame | null
Overrides
top
Get Signature
get top():
number|null
Top edge in EMU (a:off/@y), or null when the placeholder carries no own a:xfrm.
Returns
number | null
Inherited from
type
Get Signature
get type():
string|null
Placeholder type (p:ph/@type: title | body | sldNum | …), or null when absent (a body placeholder).
Returns
string | null
Inherited from
width
Get Signature
get width():
number|null
Width in EMU (a:ext/@cx), or null when the placeholder carries no own a:xfrm.
Returns
number | null
Inherited from
Methods
markDirty()
markDirty():
void
Mark the owning part dirty so save() reserializes it. Call after mutating element_.
Returns
void