Microsoft 365 Community Office Add-ins, 10 Feb 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Community demo – New PowerPoint JS APIs

Description

In this 10-minute demo, Microsoft software engineer Aishwarya Iyer delivers an update on PowerPoint JS APIs v1.12 and v1.13 preview, as well as a quick peak at upcoming APIs in development. Please try the APIs and, as always, you are invited to share your opinions and needs with us. This PnP community demo is taken from the Office Add-ins community call - February 2021, recorded on February 10, 2021.

Demo Presenter: Aishwarya Iyer (Microsoft)

Supporting documents:
• PowerPointApi 1.2 - https://docs.microsoft.com/en-us/office/dev/add-ins/reference/requirement-sets/powerpoint-api-1-2-requirement-set
• PowerPointApi 1.3 preview - https://docs.microsoft.com/en-us/office/dev/add-ins/reference/requirement-sets/powerpoint-preview-apis

Stay connected:
• Twitter https://twitter.com/microsoft365dev
• YouTube https://aka.ms/M365DevYouTube
• Blogs https://aka.ms/M365DevBlog

A

Hi everyone, so uh I'm aishwarya here and I'm a software engineer in the powerpoint team. Basically, uh the reason for this call today is because, uh since our last community call update in september last year, we've been doing a bunch of stuff shipping new apis and progressing apis to different channels, so just wanted to jump in give you all a quick update of what's going on and also ask you all to play with the existing apis and give us feedback.

A

uh We also have owner from my team, who is a software engineer and he and amit who is a program manager who are in the call, and they would help answer any questions that you may have along the way so uh what's been happening since our last call in september.

A

So in that call, we presented the insert slides from base64 api, which was uh in the preview channel that time now early in jan this year, we've been we've pushed that to ga and we've also pushed it along with a bunch of other slides which include the ability to a bunch of other apis which include the ability to delete slides, as well as some apis to access the slide collection and get the various slide objects and metadata on the slide.

A

Object and the official documentation link is here, and it has a very uh good detail of how to use the api and various examples that we've been uh working to shout. The different apis in set 1.3 and most of them are in the preview channel since a couple of weeks now, and we would love if you could play around with the apis in this set and give us feedback.

A

So what are the categories of apis in this set? One? Is uh it has a bunch of apis for slide management, which means that in 1.2 we provided basic slide collection apis where you could get like the id of the slide. The count of the slides in the deck and so on, but in this version you get uh some more sophisticated data points.

A

For example, you will get the ability to retrieve all the slide masters on the deck and also the different layouts on the various slide masters, and you will also be able to get what is the current slide master of the of any slide in your deck? So, basically, all of the retrieval apis around the template of your deck, as well as the theme of your slide.

A

We've released that, apart from that, we also added another api for adding slide this api.

A

Basically lets you add a new slide into the deck at the end of the existing slide collection and today by default it uh you can only add at the end of the collection, but soon we would also be uh releasing the ability to add it at any position in the slide where you can specify the position, but what's special about this ad slide api is that you will be able to specify the slide master and the slide layout that you want the new slide to be off.

A

So it's an optional pattern, so it's up to you like, if you have custom templates that you want to apply on newly added slides, you would be able to use that again like all this is very well documented in here. I just wanted to make sure that everyone is aware of stuff, that's already available for the public to try out, and we also added a list of shape collection apis, where you will be able to get access to the number of shapes on each slide and then the id and other metadata of shapes.

A

So you will be able to pull. Basically, these are all getter apis where you'll be able to pull shape, metadata out and uh display it in the next round of apis, which are not yet on preview, but currently under development. That's where we would be providing shape, manipulation apis.

A

In 1.3, we also have another set of tag collection apis which are not yet on preview, but they will be. They are on their way and should be there in a couple of weeks. So tags are basically custom key value pairs that you can associate to different levels on the presentation, so you can add custom tags to your uh presentation or to your slides or to your shapes. So we've also added, like a bunch of apis to add, delete and retrieve tags at various levels on the deck.

A

This is on its way to preview. We will so be on the lookout for it now. I also wanted to quickly give you a glimpse of what we are working on currently, so this is not yet documented anywhere, or this is just like to give you all a feel of uh what to expect in the near future, probably in a couple of months, and they are basically more additions to the shape collection apis.

A

So the ones in preview today are getters on the shape collection, but the new apis that you're working on are basically for manipulating the shape collection, so you'll be able to add, delete and retrieve shapes based on their type. We are also working on a set of customer data and custom xml apis.

A

Basically, customer data is so that you can again add key value pair, storing different customer data values in your deck, and you also have custom xml to store other data in xml format and you're, also working on building a bunch of text range and text based apis to manipulate them and retrieve them, and a couple of apis on selecting, slides and shapes so yeah. That is basically a quick summary of what we have. I also created a simple demo on my local server.

A

I, since the apis that I just spoke about, are very well documented and a lot of them are getters, so I'm not gonna like go into each and every one of them since they're, pretty straightforward, but I'll probably just walk you through a couple, and also I did it on my local server just so that I can show the various the apis in various channels at the same time.

A

So, uh let's start with the simple uh delete slide api that I spoke about. This delete slide. Api is present on the slide object, so once you iterate and get to the slide object, you can call the delete function so for the demo, if I just enter uh slide two, which is a video based index one.

A

So this is uh slide index zero paste index, one. So uh out of the four three uh out of the blue, slides that were present, you can see that one of them went away, and that was uh the slide that I deleted. So basically it's a very uh simple api, the other apis that I spoke about.

A

Let me just show you what I mean by uh the slide master and slide layout. So this api, so all I'm doing in the back- is basically just calling master presentation.slidemasters, just uh rendering it so this says what slide masters are present. So, as you can see, there are two themes on this deck right now and there's also another uh slide master present. So we are listing them out you. We also have apis to show the slide layout information. Let me show that as well, so because the slide layout is present on the slide master.

A

If I provide the slide master index, so we saw that there were three masters. So now you can see all of the layouts that are present here and when I say layout I mean all of these values here. So when you do an ad slide, you will be able to specify which layout you want, which presentation that you are. You want to apply on the new slide.

A

Let me also run a simple add slide example. So by default you, you don't have to specify anything all the params are optional. So if you don't do anything and just click add new, so it just adds a new slide at the end of the presentation, and it follows the template of the previous slide.

A

If you want, you can also specify the master so right now, I'm just gonna specify uh one of the ones that we just saw some time back.

A

So, as you can see master index one, there were two slide masters with the blue theme, so you can see that I was able to add it with the specified theme so yeah. So since these are like super simple apis, I I'm just doing like a super. Simple walkthrough of the apis here insert template is not really a new api. It's insert slide using base64. I just added it in case.

A

uh I wanted to add a new new template, while I demo, but since we already have some custom templates here, I'm not doing that again and then we also have apis at a different level like slide, shape and presentation.

A

This api is a bit slow on my server, but basically what it does is. It tries to add a key value pair, so I'm just putting like a sample key and a sample value, so it goes in and adds it and it displays the value here but I've. I noticed that my server is running a bit slow this morning, so you're not able to see it, but it's again like another, very simple, retrieval api, where a key value pair would have been added on the slide, object.

A

Yeah, it's a simple get api, so there's not really much. I can just show you the code here so for the tags collection.

A

So basically, what it does is what I was displaying was the tags on the slide level. Then I also had code to render the count of the slides count of the tags on the slide, and basically I was looking through them and displaying the key and the value. So it was super simple, so that is pretty much it. I just wanted to uh this. This uh presentation was mainly so I can make the community aware of what we've been doing in the last couple of months since september.

A

So yeah, please go ahead and try uh the apis on our various channels and give us feedback. If you have any and that's it. Thank you cool thanks, aishwarya, that's really great.

A