API reference

Asset

getTemporaryUrl findFonts openColorSelector requestFontSelection upload Changelog

Asset: Test

Design

addAudioTrack addElementAtCursor addElementAtPoint addNativeElement

addPage bulkCreate.launch createRichtextRange editContent getCurrentPageContext getCurrentPageMetadata getDefaultPageDimensions

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

Design: Test

Error

Error: Test

Intents

Intents: Content

prepareContentPublisher

Intents: Data

prepareDataConnector

Intents: Design

prepareDesignEditor

Intents: Test

initTestEnvironment

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

Platform: Test

initTestEnvironment

User

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

User: Test

initTestEnvironment

API reference

getCurrentPageMetadata

API reference for the getCurrentPageMetadata method.

Retrieves metadata for the page the user is currently on in the design.

Returns

Information about a page within a design. This is a Promise that resolves with the following object:

Information about a page within a design with fixed or unbounded dimensions.

typestring

The type of page.

The only valid value is "absolute".

idPageId

Optional

Stable identifier for this page within the design.

dimensionsPageDimensions

Optional

The dimensions of the page, in pixels.

This may be undefined because some types of pages don't have dimensions, such as whiteboards.

widthnumber

The width of the page, in pixels.

heightnumber

The height of the page, in pixels.

titlestring

Optional

The name of the page.

This is optional and will be empty if the user hasn't set a title.

Pages that do not have fixed or unbounded dimensions currently do not return metadata.

typestring

The type of page.

The only valid value is "unsupported".