Files
html2pptx/reference/slide.md
T

4.5 KiB
Raw Blame History

幻灯片参数 (Slide Props)

幻灯片相关类型包括 Slide 类、PresSlide 接口和 BackgroundProps,通过 pptx.addSlide() 创建。


添加幻灯片 (addSlide)

pptx.addSlide(props?: AddSlideProps): PptxGenJS.Slide

AddSlideProps

  • masterName:母版名称

    • 类型:string
    • 说明:使用已定义的 Slide Master 名称
  • sectionTitle:节标题

    • 类型:string
    • 说明:将幻灯片添加到指定节

Slide 类属性

  • background:幻灯片背景

    • 类型:BackgroundProps
    • 说明:背景颜色或图片
  • color:默认文字颜色

    • 类型:HexColor
    • 格式:6 位十六进制(无 #
    • 默认值:'000000'
  • hidden:幻灯片是否隐藏

    • 类型:boolean
    • 默认值:false
  • slideNumber:幻灯片编号选项

    • 类型:SlideNumberProps
  • newAutoPagedSlides:自动分页创建的新幻灯片

    • 类型:PresSlide[]

Slide 类方法

  • addChart(type, data, options?)

    • 说明:添加图表
    • 参数:
      • typeCHART_NAME | IChartMulti[]
      • dataany[]
      • options?IChartOpts
    • 返回:Slide
  • addImage(options)

    • 说明:添加图片
    • 参数:optionsImageProps
    • 返回:Slide
  • addMedia(options)

    • 说明:添加媒体(音频/视频)
    • 参数:optionsMediaProps
    • 返回:Slide
  • addNotes(notes)

    • 说明:添加演讲者备注
    • 参数:notesstring
    • 返回:Slide
  • addShape(shapeName, options?)

    • 说明:添加形状
    • 参数:
      • shapeNameSHAPE_NAME
      • options?ShapeProps
    • 返回:Slide
  • addTable(tableRows, options?)

    • 说明:添加表格
    • 参数:
      • tableRowsTableRow[]
      • options?TableProps
    • 返回:Slide
  • addText(text, options?)

    • 说明:添加文字
    • 参数:
      • textstring | TextProps[]
      • options?TextPropsOptions
    • 返回:Slide

PresSlide 接口

PresSlide 为内部幻灯片表示,包含以下属性和方法:

  • addChart:添加图表

    • 类型:Function
  • addImage:添加图片

    • 类型:Function
  • addMedia:添加媒体

    • 类型:Function
  • addNotes:添加备注

    • 类型:Function
  • addShape:添加形状

    • 类型:Function
  • addTable:添加表格

    • 类型:Function
  • addText:添加文字

    • 类型:Function
  • background:背景

    • 类型:BackgroundProps
  • color:默认文字颜色

    • 类型:HexColor
  • hidden:是否隐藏

    • 类型:boolean
  • slideNumber:幻灯片编号

    • 类型:SlideNumberProps

BackgroundProps

继承 DataOrPathPropspathdata)和 ShapeFillPropscolortransparencytype)。

  • path:背景图片 URL 或本地路径

    • 类型:string
    • 示例:'https://onedrives.com/myimg.png'
  • data:背景图片 base64 数据

    • 类型:string
    • 示例:'image/png;base64,iVtDafDrBF[...]='
  • color:背景颜色

    • 类型:Color(来自 ShapeFillProps
    • 格式:6 位十六进制(无 #)或主题色
  • transparency:背景透明度

    • 类型:number
    • 取值范围:0100
    • 默认值:0
  • type:填充类型

    • 类型:'none' | 'solid'
    • 默认值:'solid'

SlideNumberProps

继承 PositionPropsTextBaseProps

  • margin:边距
    • 类型:Marginnumber | [number, number, number, number]
    • 单位:pt

幻灯片布局 (PresLayout)

pptx.defineLayout(layout: PresLayout)
  • name:布局名称

    • 类型:string
    • 示例:'LAYOUT_WIDE'
  • width:宽度

    • 类型:number
    • 单位:英寸
  • height:高度

    • 类型:number
    • 单位:英寸

标准布局尺寸

常量名 宽度 高度
LAYOUT_4x3 10" 7.5"
LAYOUT_16x9 10" 5.625"
LAYOUT_16x10 10" 6.25"
LAYOUT_WIDE 13.33" 7.5"

节属性 (SectionProps)

pptx.addSection(props: SectionProps)
  • title:节标题

    • 类型:string
  • order:节顺序

    • 类型:number
    • 取值范围:1n
    • 说明:在指定索引添加节

已废弃参数 (BackgroundProps)

已废弃参数 替代参数 废弃版本
fill ShapeFillProps.color v3.6.0
src DataOrPathProps.path v3.6.0