PptxGenJS

Appearance

@shbernal/pptxgenjs

@shbernal/pptxgenjs / index / ObjectNameProps

Interface: ObjectNameProps ​

Defined in: core-interfaces.ts:790

Extended by ​

Properties ​

altText? ​

optional altText?: string

Defined in: core-interfaces.ts:807

Alt Text value ("How would you describe this object and its contents to someone who is blind?")

  • serialized to the generated object's p:cNvPr descr attribute
  • PowerPoint: [right-click on the object] > "Edit Alt Text..."

Since ​

v4.0.0

Example ​

ts
'Quarterly revenue bar chart'

objectLock? ​

optional objectLock?: ObjectLockProps

Defined in: core-interfaces.ts:819

Object lock flags (DrawingML a:spLocks / a:picLocks / a:graphicFrameLocks)

  • restrict how the object can be manipulated in PowerPoint (e.g. prevent moving, resizing, or grouping)
  • each flag maps 1:1 to the OOXML attribute of the same name; only flags set to true are emitted
  • PowerPoint UI: Selection Pane / right-click protections (most locks are honored at edit time, not as a password)
  • flags only apply to the object types that support them (see each flag); flags set on an unsupported object type are ignored with a console warning

Since ​

v4.0.0

Examples ​

ts
{ noMove: true, noResize: true } // pin an object in place
ts
{ noGrp: true } // exclude from grouping

objectName? ​

optional objectName?: string

Defined in: core-interfaces.ts:799

Object name

  • used instead of default "Object N" name
  • PowerPoint: Home > Arrange > Selection Pane...

Since ​

v3.10.0

Default ​

ts
'Object 1'

Example ​

ts
'Antenna Design 9'