Path
A path that defines the structure of a shape element.
Properties
dstringRead-onlyThe shape of the path.
This is similar to the d attribute of an SVG's path element, with some limitations:
- Must start with an
Mcommand. - Only one
Mcommand is allowed. QandTcommands are not permitted.- The path must be closed using a
Zcommand or matching start and end coordinates.
fillPathFillRead-onlyThe appearance of the path's interior.
isMediaEditablebooleanRead-onlyThis must be true.
mediaContainerobjectRead-onlyA media fill, if any.
setfunctionParameters
stateundefined | MediaFillStateA state that creates an image fill.
typestringRead-onlyThe type of media.
This must be "image".
imageRefImageRefRead-onlyA unique identifier that points to an image asset in Canva's backend.
flipXbooleanIf true, the image is flipped horizontally.
flipYbooleanIf true, the image is flipped vertically.
A state that creates a video fill.
typestringRead-onlyThe type of media.
This must be "video".
videoRefVideoRefRead-onlyA unique identifier that points to a video asset in Canva's backend.
flipXbooleanIf true, the video is flipped horizontally.
flipYbooleanIf true, the video is flipped vertically.
Returns
void
refundefined | MediaFillAn image that fills the interior of a media.
typestringRead-onlyThe type of media.
This must be "image".
imageRefImageRefRead-onlyA unique identifier that points to an image asset in Canva's backend.
flipXbooleanIf true, the image is flipped horizontally.
flipYbooleanIf true, the image is flipped vertically.
A video that fills the interior of a media.
typestringRead-onlyThe type of media.
This must be "video".
videoRefVideoRefRead-onlyA unique identifier that points to a video asset in Canva's backend.
flipXbooleanIf true, the video is flipped horizontally.
flipYbooleanIf true, the video is flipped vertically.
colorContainerobjectRead-onlyA color fill, if any.
setfunctionParameters
stateundefined | SolidFillStatetypestringRead-onlyThe type of color.
This must be "solid".
colorstringThe 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
refundefined | ColorFillA solid color that fills an interior.
typestringRead-onlyThe type of color.
This must be "solid".
colorstringThe 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-onlyThis must be "unsupported".
isMediaEditablebooleanRead-onlyThis must be false.
mediaContainerobjectRead-onlyA media fill, if any. MediaFill is not editable
refundefined | MediaFillAn image that fills the interior of a media.
typestringRead-onlyThe type of media.
This must be "image".
imageRefImageRefRead-onlyA unique identifier that points to an image asset in Canva's backend.
flipXbooleanIf true, the image is flipped horizontally.
flipYbooleanIf true, the image is flipped vertically.
A video that fills the interior of a media.
typestringRead-onlyThe type of media.
This must be "video".
videoRefVideoRefRead-onlyA unique identifier that points to a video asset in Canva's backend.
flipXbooleanIf true, the video is flipped horizontally.
flipYbooleanIf true, the video is flipped vertically.
colorContainerobjectRead-onlyA color fill, if any.
setfunctionParameters
stateundefined | SolidFillStatetypestringRead-onlyThe type of color.
This must be "solid".
colorstringThe 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
refundefined | ColorFillA solid color that fills an interior.
typestringRead-onlyThe type of color.
This must be "solid".
colorstringThe 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-onlyThis must be "unsupported".
strokeStroke | undefinedRead-onlyThe stroke (outline) of the path, if any.
For more information, see Stroke.