Skip to content

Commit ea088ce

Browse files
author
Luke Vella
committed
Update jsdoc
1 parent 531acf3 commit ea088ce

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

src/group.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ export class Group {
2020
}
2121

2222
/**
23-
* Add chart to Slide
23+
* Add chart to Group
2424
* @param {CHART_NAME|IChartMulti[]} type - chart type
2525
* @param {object[]} data - data object
2626
* @param {IChartOpts} options - chart options
27-
* @return {Slide} this Slide
27+
* @return {Group} this Group
2828
*/
2929
addChart(type: CHART_NAME | IChartMulti[], data: any[], options?: IChartOpts): Group {
3030
// FUTURE: TODO-VERSION-4: Remove first arg - only take data and opts, with "type" required on opts
@@ -36,30 +36,30 @@ export class Group {
3636
}
3737

3838
/**
39-
* Add image to Slide
39+
* Add image to Group
4040
* @param {ImageProps} options - image options
41-
* @return {Slide} this Slide
41+
* @return {Group} this Group
4242
*/
4343
addImage(options: ImageProps): Group {
4444
genObj.addImageDefinition(this, this._slide, options)
4545
return this
4646
}
4747

4848
/**
49-
* Add media (audio/video) to Slide
49+
* Add media (audio/video) to Group
5050
* @param {MediaProps} options - media options
51-
* @return {Slide} this Slide
51+
* @return {Group} this Group
5252
*/
5353
addMedia(options: MediaProps): Group {
5454
genObj.addMediaDefinition(this, this._slide, options)
5555
return this
5656
}
5757

5858
/**
59-
* Add shape to Slide
59+
* Add shape to Group
6060
* @param {SHAPE_NAME} shapeName - shape name
6161
* @param {ShapeProps} options - shape options
62-
* @return {Slide} this Slide
62+
* @return {Group} this Group
6363
*/
6464
addShape(shapeName: SHAPE_NAME, options?: ShapeProps): Group {
6565
// NOTE: As of v3.1.0, <script> users are passing the old shape object from the shapes file (orig to the project)
@@ -72,10 +72,10 @@ export class Group {
7272
}
7373

7474
/**
75-
* Add table to Slide
75+
* Add table to Group
7676
* @param {TableRow[]} tableRows - table rows
7777
* @param {TableProps} options - table options
78-
* @return {Slide} this Slide
78+
* @return {Group} this Group
7979
*/
8080
addTable(tableRows: TableRow[], options?: TableProps): Group {
8181
// FUTURE: we pass `this` - we dont need to pass layouts - they can be read from this!
@@ -84,10 +84,10 @@ export class Group {
8484
}
8585

8686
/**
87-
* Add text to Slide
87+
* Add text to Group
8888
* @param {string|TextProps[]} text - text string or complex object
8989
* @param {TextPropsOptions} options - text options
90-
* @return {Slide} this Slide
90+
* @return {Group} this Group
9191
*/
9292
addText(text: string | TextProps[], options?: TextPropsOptions): Group {
9393
let textParam = typeof text === 'string' || typeof text === 'number' ? [{ text: text, options: options } as TextProps] : text

types/index.d.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2140,47 +2140,47 @@ declare namespace PptxGenJS {
21402140

21412141
export class Group {
21422142
/**
2143-
* Add chart to Slide
2143+
* Add chart to Group
21442144
* @param {CHART_NAME|IChartMulti[]} type - chart type
21452145
* @param {object[]} data - data object
21462146
* @param {IChartOpts} options - chart options
2147-
* @return {Slide} this Slide
2147+
* @return {Group} this Group
21482148
* @type {Function}
21492149
*/
2150-
addChart(type: CHART_NAME | IChartMulti[], data: any[], options?: IChartOpts): Slide
2150+
addChart(type: CHART_NAME | IChartMulti[], data: any[], options?: IChartOpts): Group
21512151
/**
2152-
* Add image to Slide
2152+
* Add image to Group
21532153
* @param {ImageProps} options - image options
2154-
* @return {Slide} this Slide
2154+
* @return {Group} this Group
21552155
*/
2156-
addImage(options: ImageProps): Slide
2156+
addImage(options: ImageProps): Group
21572157
/**
2158-
* Add media (audio/video) to Slide
2158+
* Add media (audio/video) to Group
21592159
* @param {MediaProps} options - media options
2160-
* @return {Slide} this Slide
2160+
* @return {Group} this Group
21612161
*/
2162-
addMedia(options: MediaProps): Slide
2162+
addMedia(options: MediaProps): Group
21632163
/**
2164-
* Add shape to Slide
2164+
* Add shape to Group
21652165
* @param {SHAPE_NAME} shapeName - shape name
21662166
* @param {ShapeProps} options - shape options
2167-
* @return {Slide} this Slide
2167+
* @return {Group} this Group
21682168
*/
2169-
addShape(shapeName: SHAPE_NAME, options?: ShapeProps): Slide
2169+
addShape(shapeName: SHAPE_NAME, options?: ShapeProps): Group
21702170
/**
2171-
* Add table to Slide
2171+
* Add table to Group
21722172
* @param {TableRow[]} tableRows - table rows
21732173
* @param {TableProps} options - table options
2174-
* @return {Slide} this Slide
2174+
* @return {Group} this Group
21752175
*/
2176-
addTable(tableRows: TableRow[], options?: TableProps): Slide
2176+
addTable(tableRows: TableRow[], options?: TableProps): Group
21772177
/**
2178-
* Add text to Slide
2178+
* Add text to Group
21792179
* @param {string|TextProps[]} text - text string or complex object
21802180
* @param {TextPropsOptions} options - text options
2181-
* @return {Slide} this Slide
2181+
* @return {Group} this Group
21822182
*/
2183-
addText(text: string | TextProps[], options?: TextPropsOptions): Slide
2183+
addText(text: string | TextProps[], options?: TextPropsOptions): Group
21842184
addGroup(): Group
21852185
}
21862186

0 commit comments

Comments
 (0)