Skip to main content
All CollectionsUsing the Platform
How to Create Custom Components in Orbify
How to Create Custom Components in Orbify
Laura Cassone avatar
Written by Laura Cassone
Updated over 2 months ago

Creating custom components in Orbify allows users to tailor their data visualizations and outputs to meet specific project requirements. This guide will walk you through the steps to create your own components using Orbify's intuitive interface.

Step 1: Accessing Platform Settings

To begin, navigate to the platform settings by clicking on the gear icon located in the top right corner of your Orbify dashboard. This section provides various customization options for your project.

Step 2: Finding the Custom Components Section

Once you are in the platform settings, scroll down to find the Custom Components section. This is where you can manage your existing components and create new ones.

Step 3: Creating a New Component

Click on the Create Component button. This action will open a new interface where you can define your custom component.

Step 3.1: Naming Your Component

First, you’ll need to select a component name. Choose a name that accurately reflects the function or purpose of your component for easy identification later.

Step 3.2: Writing a Description

Next, provide a description for your component. This is an essential step that helps other users (or your future self) understand the component's functionality and how it can be utilized within your projects.

Step 3.3: Selecting the Output Type

Now it's time to select the output type for your component. You have several options to choose from:

  • Layer: A single layer of data.

  • Layer Group: A collection of multiple layers.

  • Chart: A graphical representation of data.

  • Chart Group: A collection of multiple charts.

  • Simple Stat: A straightforward statistical representation.

  • Min Max Avg Stat: A statistical representation showing minimum, maximum, and average values.

Choose the output type that best suits the data representation you are aiming for.

Step 4: Using GitHub Remote Code

If you want to enhance your component with custom code, you can leverage GitHub remote code. To use this option:

  1. Select the GitHub Remote Code checkbox.

  2. Once selected, you’ll be able to choose the branch and the module from your GitHub repository that you want to integrate into your component.

This feature enables you to use existing code to create powerful and flexible components, enhancing your workflow and project efficiency.

Conclusion

Creating custom components in Orbify is a straightforward process that empowers users to customize their data visualizations. By following these steps, you can create components tailored to your specific needs, improving the overall functionality of your projects. Whether you are looking to create layers, charts, or statistical representations, Orbify provides the tools to help you succeed.

Start experimenting with custom components today and take full advantage of what Orbify has to offer!

Did this answer your question?