Skip navigation

Skip to main content

On September 25th, 2024, we released v2 of the Apps SDK. To learn what’s new and how to upgrade, see Migration FAQ and Migration guide.

API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement addPage createRichtextRange editContent getCurrentPageContext getDefaultPageDimensions 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

AbsolutePage

API reference for the AbsolutePage type.

A page with either fixed or unbounded dimensions.

Properties

typestringRead-onlyRequired

The type of page.

lockedbooleanRead-onlyRequired

If true, the page is locked and cannot be modified.

dimensionsDimensions | undefinedRead-onlyRequired

The dimensions of the page. dimensions is undefined for whiteboard pages.

widthnumberRead-onlyRequired

A width, in pixels.

heightnumberRead-onlyRequired

A height, in pixels.

backgroundFill | undefinedRead-onlyRequired

The background of the page. background is undefined for whiteboard pages.

For more information, see Fill.

elementsElementListRead-onlyRequired

The elements on the page.

For more information, see ElementList.