Document toolboxDocument toolbox

Structure JavaScript API Reference

Owned by Jaramy Conners
May 16, 2024
1 min read

Structure's JavaScript API provides ways to extend the client-side functionality of the Structure plugin.

  • JavaScript API Functions — This page lists static functions exposed by the Structure API.
  • JavaScript API Classes — Structure Javascript API provides a number of classes to be used as base for your own column type implementations. This should be done using subClass() method.
    • Column Class — A subclass of Column class represents column objects of a specific type.
    • ColumnConfigurator Class — ColumnConfigurator class encapculates everything related to column type configuration.
    • ColumnOption Class — ColumnOption class represents a single column configuration parameter.
    • ColumnType Class — ColumnType class represents column type.
    • ItemDetailsProvider Class — ItemDetailsProvider class is the extension point for item details.
  • JavaScript API Objects — This page lists objects exposed by the Structure API.
    • ItemDetailsBridge Object — ItemDetailsBridge provides api for interaction with the Structure app and item details lifecycle.