DOCSEARCHbyAlgolia
Submit Docs

Re:Earth Documentation

website·Indexed 34 days ago

https://docs.reearth.io/

Documentation for Re:Earth and Re:Earth CMS, a headless CMS designed to handle both standard content and geospatial data. Includes guides on managing models, items, assets, and schemas, as well as instructions for importing/exporting content via JSON, CSV, and GeoJSON.

Tokens
59.9K
Snippets
212
Records
454
Agent score
53%

What's inside Re:Earth

  1. Overview of the Re:Earth Visualizer Plugin API

    The Plugin API allows plugins to communicate with Re:Earth Visualizer without requiring access to the Visualizer's source code. It enables developers to read data, respond to user interactions, control map displays, and manage custom UIs. All API functionality is accessed through a single global object: reearth.

  2. Overview of the Re:Earth Visualizer Plugin API

    The Re:Earth Visualizer Plugin API allows plugin extensions to integrate with the Visualizer. It provides access to Visualizer data and methods to manage components such as layers, the viewer, camera, timeline, UI, and extensions. The API is exposed via a global reearth object available on the WebAssembly side of the plugin.

  3. Overview of Asset Management in Re:Earth CMS

    Assets are files uploaded to a project and are accessible from any model within that project. Assets are managed via the Assets screen in the left menu. Permissions for asset management are as follows:

    • Owners/Administrators: Can upload, download, and delete all assets.
    • Editors: Can upload assets and delete assets they personally uploaded.
    • Viewers: Can view and download assets.

  4. Overview of Re:Earth CMS

    Re:Earth CMS is a headless Content Management System (CMS) designed to handle not only standard text and images but also geospatial data. Unlike traditional CMSs where the management system and the display layer are integrated, Re:Earth CMS decouples data management from the presentation. Data is managed centrally and delivered to various front-ends (websites, apps, IoT devices, digital signage) via APIs, ensuring consistency across all delivery channels.

  5. Overview of ReEarth item field types

    When creating fields in the schema screen for items, you must select one of the following field types to determine the kind of data the field can store:

  6. Create and reuse field groups across models

    Groups allow you to bundle multiple fields together and reuse them across multiple models. Groups are created in the Schema screen. When a group is added to a model via the 'Group' field type, the model references the group rather than duplicating it. Consequently, any changes made to the fields within a group are automatically reflected in all models using that group.

  7. Understand reearth comment functionality

    Comments allow members to communicate regarding specific entities within reearth. Comments can be posted and viewed from both the list and detail screens of the following targets:

    • Items (Content)
    • Assets
    • Requests

  8. Control the Re:Earth Visualizer timeline from a plugin

    The reearth.timeline namespace allows plugins to manage the scene's chronological data and animations. Because the timeline may not be available in all contexts, methods should be called using optional chaining (?.).

  9. Visualize CMS data on 3D maps with CMS Data Visualizer

    The CMS Data Visualizer plugin allows you to visualize data from the CMS on a 3D map, providing capabilities to customize markers and information displays.

  10. Choose the appropriate Re:Earth CMS integration method

    Re:Earth CMS provides three primary ways to interact with its data and resources depending on the use case and security requirements:

    • Public API: Used for viewing and posting data within the public scope. Ideal for frontend applications like websites, map apps, and public forms. Supports JSON, CSV, and GeoJSON formats.
    • Integration API: Used for full CRUD operations and management of CMS resources (projects, models, schemas, items, and assets). This must be used in a secure backend environment.
    • Webhook: Used for real-time notifications of CMS events (e.g., item creation, updates, asset uploads) sent to a specified external URL. Ideal for data synchronization and workflow automation.

  11. Manage Re:Earth CMS resources using the Integration API

    The Integration API is a RESTful management API used to create, update, and delete resources within the Re:Earth CMS from external services. Unlike the Public API, the Integration API allows access to resources that are not set to public and requires authentication via an integration token. Key capabilities include managing project data, creating/updating/deleting models, items, and schemas, and managing assets and comments.

  12. Get viewport dimensions and device info via reearth.viewer.viewport

    The reearth.viewer.viewport object provides information about the current map area and the page's URL query parameters. isMobile is determined based on bowser's user-agent detection.
    type Viewport = {
  width: number;
  height: number;
  isMobile: boolean;
  query: Record<string, string>;
};

reearth.viewer.viewport: Viewport;