Description: This property is a unique string identifier assigned to a specific plugin within the Reearth environment. This identifier allows the Reearth system and developers to distinctly recognize, reference, and manage each plugin, ensuring that interactions and operations are correctly targeted. The ID helps differentiate plugins, particularly in environments where multiple plugins might be operating concurrently or where plugins have extensions requiring consistent identification.
Type:
id: string;
string //Uniquely identifies the plugin. It is assigned upon the plugin's registration and remains consistent throughout its lifecycle.
Description: This is crucial attribute that represents the unique identifier (ID) of a specific extension within the plugin. This ID is vital for distinguishing between various extensions that a single plugin might offer. Extensions within a plugin can provide different functionalities, such as different types of visualizations, tools, or data processing capabilities. The extensionId ensures that the correct extension is being utilized or referenced in operations, settings adjustments, and interactions within the Reearth platform.
Type:
extensionId: string;
string //Acts as the unique identifier for a particular extension of the plugin. This ID is essential for accurately targeting and managing specific extensions within the broader context of a plugin's offerings.
Description: This property denotes the type of extension that is currently active or being referenced in a plugin. It categorizes the extension based on its functionality or role within the plugin system. Common types of extensions might include "widget", which represents a UI component that interacts with users, or "block", which refers to a functional or data-processing component that enhances or extends the capabilities of the Reearth platform. Identifying the extension type is crucial for understanding the extension's capabilities and for ensuring it is used appropriately within the project's context.
Type:
extensionType: string;
string //Describes the category or type of the extension. This categorization helps in managing and utilizing the extension according to its intended purpose and functionality within the Reearth environment.
Description: This is an optional attribute that holds custom data or configuration settings associated with the plugin. This property is highly flexible and can contain any type of data that the plugin needs to function or that enhances its capabilities. This could include configurations like user settings, visual preferences, operational parameters, or other data necessary for the plugin's functionality. The ability to store and retrieve this property allows developers to customize and control plugin behavior dynamically, adapting the plugin to specific project requirements or user preferences.
Type:
property?: any;
any: // This property can be of any type, reflecting its ability to store diverse data structures. This flexibility allows it to accommodate simple values, complex objects, arrays, or even nested data structures, depending on what the plugin requires for its operation and customization.
// This design ensures that the property can be tailored to meet the broad needs of various plugins within the Reearth ecosystem.