Home > @unseenco/backstage-core > ISheetObject
ISheetObject interface
Public API for a Backstage.js sheet object (animated props and Studio integration).
Signature:
typescript
export interface ISheetObject<Props extends UnknownShorthandCompoundProps = UnknownShorthandCompoundProps>Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| address | SheetObjectAddress | An object representing the address of the Object | |
| project | IProject | The Project the project belongs to | |
| props | Pointer<this['value']> | A Pointer to the props of the object. More documentation soon. | |
| sheet | ISheet | The instance of Sheet the Object belongs to | |
| type | 'Backstage_SheetObject_PublicAPI' | All Objects will have object.type === 'Backstage_SheetObject_PublicAPI' | |
| value | PropsValue<Props> | The current values of the props. |
Methods
| Method | Description |
|---|---|
| addProps(config, opts) | Add new props to this object's config. Existing props are preserved; only the keys in config are added. Throws if a key already exists on the object. |
| getShowPropsOf() | Returns the objects currently linked via . |
| onValuesChange(fn, rafDriver) | Calls fn every time the value of the props change. |
| reconfigure(config, opts) | Replace this object's prop config. Props removed from config disappear from the Studio details pane; historic statics/tracks for those paths are stripped. Same effect as sheet.object(key, config, {reconfigure: true}). |
| showPropsOf(objects) | Show another object's props in this object's Studio details pane. Runtime-only (not persisted). Edits and sequencing still target the source objects. Pass [] to clear. |