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

Stroke

API reference for the Stroke 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.

Represents an outline, such as the border of an element.

Properties

weightnumber

Required

The weight (thickness) of the stroke.

Minimum: 0

Maximum: 100

colorContainerobjectRead-only

Required

The color of the stroke.

refColorFill

Required

A solid color that fills an interior.

typestringRead-only

Required

The type of color.

This must be "solid".

colorstring

Required

The color of the fill. This must be a valid, six-digit hex code, prefixed with a # symbol.

Must be six characters long.
Must start with a #.
Must use lowercase letters.

Example

"#ff0099"

Represents something that's not supported by the Apps SDK.

typestringRead-only

Required

This must be "unsupported".

setfunction

Required

Parameters

stateSolidFillState

Required

A state that creates a solid color fill.

typestringRead-only

Required

The type of color.

This must be "solid".

colorstring

Required

The color of the fill. This must be a valid, six-digit hex code, prefixed with a # symbol.

Must be six characters long.
Must start with a #.
Must use lowercase letters.

Example

"#ff0099"

Returns

void