API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement addPage createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions getDesignMetadata getDesignToken initAppElement openDesign overlay.registerOnCanOpen requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

Intents: data

prepareDataConnector

Intents: design

prepareDesignEditor

Platform

appProcess appProcess.broadcastMessage appProcess.current appProcess.current.getInfo appProcess.current.requestClose appProcess.current.setOnDispose appProcess.requestClose appProcess.registerOnMessage appProcess.registerOnStateChange features.isSupported features.registerOnSupportChange getPlatformInfo notification.addToast requestOpenExternalUrl

User

auth.getCanvaUserToken auth.initOauth

API reference

PageRefList

API reference for the PageRefList type.

This version of the API is a preview. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

A list containing the references to pages in the design.

Methods

countfunction

Required

Returns

The number of items.

number

toArrayfunction

Required

Returns

An array containing all items. The items are the same as in the list.

For more information, see PageRef.

forEachfunction

Required

Parameters

callbackForEachCallback<PageRef>

Required

The function to run for each item.

For more information, see PageRef.

Parameters

itemPageRef

Required

The current item in the list.

For more information, see PageRef.

Returns

void

Returns

void

filterfunction

Required

Parameters

filterFilterPredicate<PageRef>

Required

A function that tests each item. Returns true to keep the item.

For more information, see PageRef.

Parameters

itemPageRef

Required

The item to test.

For more information, see PageRef.

Returns

true if the item should be included, otherwise false.

boolean

Returns

An array of items that passed the test.

For more information, see PageRef.