BaseComponent.canvases Property

Parent Object: BaseComponent

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.


Defined in namespace "adsk::fusion" and the header file is <Fusion/Components/BaseComponent.h>

Description

Returns the canvases collection associated with this component. This provides access to the existing canvases and supports the creation of new canvases.

Syntax

"baseComponent_var" is a variable referencing a BaseComponent object.

# Get the value of the property.
propertyValue = baseComponent_var.canvases
"baseComponent_var" is a variable referencing a BaseComponent object.
#include <Fusion/Components/BaseComponent.h>

// Get the value of the property.
Ptr<Canvases> propertyValue = baseComponent_var->canvases();

Property Value

This is a read only property whose value is a Canvases.

Version

Introduced in version July 2023