API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload Changelog

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement

addPage bulkCreate.launch createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions

getDesignMetadata getDesignTemplateMetadata getDesignToken initAppElement openDesign overlay.registerOnCanOpen publish.launch requestExport selection.registerOnChange setCurrentPageBackground ui.startDragToCursor ui.startDragToPoint ui.startDrag

Changelog

Error

Changelog

Intents

Changelog

Intents: Content

prepareContentPublisher

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 Changelog

User

auth.getCanvaUserToken auth.initOauth monetization.isEnabled monetization.openTrackingSession monetization.requestEnableBillableAction Changelog

API reference

PageRefList

API reference for the PageRefList type.

A list containing the references to pages in the design.

Methods

countfunction

Required

Gets the number of items in the list.

Returns

The number of items.

number

toArrayfunction

Required

Converts the list to an array.

Returns

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

For more information, see PageRef.

forEachfunction

Required

Executes a function for each item in the list.

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

Creates a new array with items that match a specific type.

Parameters

filterTypeFilterPredicate<PageRef, C>

Required

A function that checks if an item is of type C.

For more information, see PageRef.

Parameters

itemPageRef

Required

The item to test.

For more information, see PageRef.

Returns

true if the item is of type C, otherwise false.

item is C

Returns

An array of items that are of type C.

readonly C[]

Creates a new array with items that pass a test.

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.