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 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

getDefaultPageDimensions

API reference for the getDefaultPageDimensions method.

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.

Gets the default dimensions that a new page will have when it is added to a design. It is possible for a user to resize a page without resizing the entire design, e.g. by clicking "Expand to Whiteboard". However, there will always be a single set of default dimensions for a design that is applied whenever a new page is created.

Returns undefined if the design is unbounded (e.g. Whiteboard or Doc).

Returns

A Promise that resolves with either undefined or the following object:

widthnumber

A width, in pixels.

heightnumber

A height, in pixels.