<aside>
💡 An array of Block
objects, each potentially representing a different piece of content or functionality within the infobox.
</aside>
Description: This serves as a unique identifier for that specific block within an infobox
. Each block, being a component of the layer's infobox
, can represent different types of content or functionality, such as text, images, interactive elements, or custom visualizations. The id
is essential for distinctly referencing, managing, and manipulating these blocks, especially when multiple blocks are used within a single infobox
or across multiple infoboxes
within a project.
Type:
id: string;
string //The id is a string that uniquely identifies each block within the infobox structure.
//This ID ensures that each block can be individually accessed, updated, or removed programmatically, providing a reliable way to handle dynamic content within infoboxes efficiently and accurately.
Description: This optional string that identifies the plugin associated with the block. This property links a block to a specific plugin that extends the functionality or content of the infobox within which the block resides. By specifying a pluginId
, the block can utilize specific functionalities, tools, or content types provided by the plugin, enhancing the block's capabilities or presentation within the infobox. This is particularly useful in modular application architectures where plugins are used to add custom features or data processing capabilities dynamically.
Type:
pluginId?: string;
string //The pluginId is an optional string that serves as the identifier for the plugin associated with the block.
//If specified, it indicates that the block is using or is dependent on a particular plugin for its operations or content rendering.
//If this property is not set, it implies that the block either does not depend on any external plugins for its functionality or relies on default settings provided by the system.
Description: This is an optional string that specifically identifies an extension within a plugin that is associated with the block. This property is crucial when a block is intended to utilize a particular functionality or feature provided by an extension of a plugin. By linking a block to an extension, the extensionId
enables the block to incorporate specialized functionalities, components, or content that are not inherently part of the core plugin but are offered as additional capabilities through its extensions. This facilitates a higher level of customization and allows developers to enhance the interactivity and utility of infoboxes within Reearth projects.
Type:
extensionId?: string;
string //The extensionId is an optional string that serves as the identifier for a specific extension within a plugin linked to the block.
//If this property is provided, it clearly defines which extension the block is using to derive its functionality or content.
//If it is absent, the block either does not utilize any specific extensions within a plugin or relies solely on the general functionalities provided by the plugin itself.
//This selective use of extensions allows for precise and targeted enhancements within the layer's infobox configuration.
Description: The property
attribute on a Block
object is an optional generic parameter (P
) that holds custom properties specific to that block. This property is designed to store any data or configuration settings that determine how the block behaves or appears within an infobox. It provides a flexible structure to accommodate various data types and structures, allowing developers to customize block functionality to meet specific requirements or user interactions. The nature of the data stored in property
can vary widely depending on the block's role and the extension's capabilities, ranging from simple text content to complex interactive controls or dynamic data visualizations.
Type:
property?: P;
P: //The property is a generic type that can be any data structure, allowing for significant flexibility in what it can contain.
//This property could include simple values like strings or numbers, or more complex objects with multiple fields and nested data.
//The specific type P is defined by the developer based on the block's requirements and the type of data or configuration it needs to function effectively within the infobox.
Description: The propertyId
property on a Block
object is an optional string that serves as a unique identifier linking the block to a specific set of external properties. This identifier is used to associate the block with predefined properties stored outside the direct structure of the block, typically in a centralized property management system within the Reearth platform. The propertyId
facilitates the dynamic application of these properties to the block, enabling the block to inherit attributes, configurations, or behavior defined by these external properties without duplicating data within the block itself.
Type:
propertyId?: string;
string //The propertyId is an optional string that acts as the unique identifier for an external set of properties.
//If provided, it indicates that the block's properties are being managed externally and should be retrieved or influenced by the referenced property set.
//If this property is not specified, it implies that the block either uses locally defined properties within the property field or does not utilize any specialized properties beyond default settings.
//This setup allows for efficient management of properties, especially in complex systems where multiple blocks might share similar configurations or attributes, promoting reuse and consistency across the application.