Home > @theatre/core > ISheetObject

ISheetObject interface

Signature:

export interface ISheetObject<Props extends IShorthandCompoundProps = {}> 

Properties

Property 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 'Theatre_SheetObject_PublicAPI' All Objects will have object.type === 'Theatre_SheetObject_PublicAPI'
value ShorthandPropToLonghandProp<Props>['valueType'] The current values of the props.

Methods

Method Description
onValuesChange(fn) Calls fn every time the value of the props change.