API sankore : add removePage() function

[profil-digital]

We have created a widget that uses the Sankore API and the addObject function to add a page to the document.

I cannot find a function to delete pages directly with the API.

I would like to do something like:
const pageCount = await window.sankore.pageCount();
for (let i = pageCount - 1; i >= 1; i--) {
await window.sankore.removePage(i);
}

The goal would be to delete all added pages except the first page where the widget is located.

Is it possible to add this function?

Thank you for your help, and well done to the whole team.

[letsfindaway]

Thanks for your proposal. I will look into this and think the API could need more extensions for page navigation and manipulation. I think about:

Navigation

• nextPage()
• previousPage()
• gotoPage(index)

Manipulation

• insertPage(index)
• deletePage(index, approve)
• deletePages(from, to, approve)
approve is a boolean indication whether user approval is requested or not.
• movePage(from, to)
• copyPage(from, to)

The only API functions we already have are currentPageNumber() and pageThumbnail(pageNumber). However those use a 1-based page number as it is also written below the thumbnails. I saw that your code assumed a zero-based index, and this is also what OpenBoard uses internally at most places. So I'm still wondering what would be best:

• keep the 1-based page number and use it everywhere in the API
• move to a zero-based page index and deprecate the old API functions

Any opinions?

Another point where I would like your opinion:

• We could implement these functions just as slots, so that they can be invoked without using async. They are still executed asynchronously, i.e. after returning from the JavaScript call you cannot be sure that the action is already completed. However since other such calls are queued and executed in order, you can expect that it is completed before the next API call manipulation the pages is processed.
• The other option is to make them returning a boolean value indicating success. Then we would need the async to get the return value. And we can be sure that the action is completed when we get this value.

I think I will go for the second option and let them return a bool. You can then still invoke them like a function without async if you are not interested in the return value.