The type has been superseded by ElementAtPoint.
An element that's natively supported by the Canva editor and has positional properties.
Images Videos Embeds Text Shapes Groups
The type has been superseded by ImageElementAtPoint.
An element that renders image content and has positional properties.
A description of the image content.
Properties of altText Indicates where the alternative text should be displayed.
If true, the alternative text will only be displayed in the editor.
If false, the alternative text will be displayed in the editor and in view-only mode.
The type of element.
This must be "image".
A data URL that contains the image data.
A unique identifier that points to an image asset in Canva's backend.
The distance from the left edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
The distance from the top edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
A rotation, in degrees.
Minimum: -180
Maximum: 180
A height, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
A width, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
The type has been superseded by VideoElementAtPoint.
An element that renders video content and has positional properties.
A description of the video content.
Properties of altText Indicates where the alternative text should be displayed.
If true, the alternative text will only be displayed in the editor.
If false, the alternative text will be displayed in the editor and in view-only mode.
A unique identifier that points to a video asset in Canva's backend.
The type of element.
This must be "video".
The distance from the left edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
The distance from the top edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
A rotation, in degrees.
Minimum: -180
Maximum: 180
A height, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
A width, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
The type has been superseded by EmbedElementAtPoint.
An element that renders rich media, such as a YouTube video, and has positional properties.
The type of element.
This must be "embed".
The URL of the rich media.
This URL must be supported by the Iframely API.
The distance from the left edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
The distance from the top edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
A rotation, in degrees.
Minimum: -180
Maximum: 180
A height, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
A width, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
The type has been superseded by TextElementAtPoint.
An element that renders text content and has positional properties.
The text content.
Only the first element in this array is used.
The distance from the left edge of the container, in pixels.
Minimum: -32768
Maximum: 32767
The distance from the top edge of the container, in pixels.
Minimum: -32768
Maximum: 32767
The type of element.
This must be "text".
The rotation of the element, in degrees.
Minimum: -180
Maximum: 180
The width of the element, in pixels.
Minimum: 0
Maximum: 32767
The color of the text as a hex code.
The hex code must include all six characters and be prefixed with a # symbol.
Example
The decoration of the font.
Default Value : "none"
The available options include:
A unique identifier that points to a font asset in Canva's backend.
The size of the text.
Default Value : 16
The style of the font.
Default Value : "normal"
The available options include:
The weight (thickness) of the font.
Default Value : "normal"
The available options include:
"normal""thin""extralight""light""medium""semibold""bold""ultrabold""heavy" The alignment of the text.
Default Value : "start"
The available options include:
"start""center""end""justify" The type has been superseded by ShapeElementAtPoint.
An element that renders a vector shape and has positional properties.
The paths that define the structure of the shape.
There must be between 1 and 30 paths (inclusive).
The maximum combined size of all paths must not exceed 2kb.
The maximum number of unique fill colors across all paths is 6.
Properties of paths The shape of the path.
This is similar to the d attribute of an SVG's path element, with some limitations:
The path must start with an M command.
The path must not have more than one M command.
The path must not use the Q command.
The path must be closed, either by:
Using a Z command at the end of the path
Having the last coordinate match the first coordinate
The appearance of the path's interior.
Properties of fill An image or video to use as the fill.
An image asset that fills a path's interior.
A unique identifier that points to an image asset in Canva's backend.
The type of fill.
This must be "image".
A video asset that fills a path's interior.
A unique identifier that points to a video asset in Canva's backend.
The type of fill.
This must be "video".
The color of the fill as a hex code.
The hex code must include all six characters and be prefixed with a # symbol.
Example
If true, users can replace a fill by dropping an image or video onto it.
The outline of the path.
Properties of stroke The color of the stroke as a hex code.
The hex code must include all six characters and be prefixed with a # symbol.
Example
The alignment of the stroke.
This must be "inset".
The weight (thickness) of the stroke.
The type of element.
This must be "shape".
Options for configuring the scale and cropping of a shape.
Properties of viewBox The height of the view box, in pixels.
The distance of the shape from the left edge of the element, in pixels.
The distance of the shape from the top edge of the element, in pixels.
The width of the view box, in pixels.
The distance from the left edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
The distance from the top edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
A rotation, in degrees.
Minimum: -180
Maximum: 180
A height, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
A width, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
The type has been superseded by GroupElementAtPoint.
An element that contains two or more elements and has positional properties.
The elements to render within the group.
Each element within a group must have dimensions and a position.
The dimensions and positions are relative to the dimensions and positions of the group.
The type of element.
This must be "group".
The distance from the left edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
The distance from the top edge of the container, in pixels.
The pixels are relative to their container.
Minimum: -32768
Maximum: 32767
A rotation, in degrees.
Minimum: -180
Maximum: 180
A height, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
A width, in pixels.
The pixels are relative to their container.
Minimum: 0
Maximum: 32767
An element that renders richtext content.
This type includes properties for controlling the position and dimensions of the
element.
It will be positioned and sized relative to its parent container.
The parent container may be an app element, or the current page.
The richtext content.
Properties of range Appends the specified characters to the end of the range.
Parameters
The characters to append to the richtext range.
Returns
A segment of a richtext range.
Properties of bounds The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
The number of characters in the segment, starting from the index.
Formats a region of text with inline formatting properties.
Parameters
The segment of the range on which to apply the formatting.
Properties of bounds The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
The number of characters in the segment, starting from the index.
Returns
void
Returns the current state of the richtext as plaintext.
Returns
string
Returns the current state of the richtext as one or more text regions.
Each region is an object that contains the text content and its formatting.
Returns
The plaintext content of the region.
Replaces a region of text with the specified characters.
Parameters
The segment of the range to replace.
Properties of bounds The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
The number of characters in the segment, starting from the index.
The replacement characters.
Returns
The bounds of the replacement characters within the updated range.
Properties of bounds The starting position of the segment.
This is zero-based, meaning the first character of the range is at index 0.
The number of characters in the segment, starting from the index.
The type of element.
This must be "richtext".
The distance from the left edge of the container, in pixels.
Minimum: -32767
Maximum: 32767
The distance from the top edge of the container, in pixels.
Minimum: -32767
Maximum: 32767
The rotation, in degrees.
Minimum: -180
Maximum: 180
The width, in pixels.
Minimum: 0
Maximum: 32767