RenderSchedule.ScriptReference Class

A reference to a RenderSchedule.Script, optionally identifying the source of the script.

@see - DisplayStyle.loadScheduleScript and DisplayStyleState.scheduleScript to obtain the script reference for a display style on the frontend and backend respectively.

Methods

Name Description
constructor(script: RenderSchedule.Script): RenderSchedule.ScriptReference Create a reference to a RenderSchedule.ScriptReference.script with no RenderSchedule.ScriptReference.sourceId.  
constructor(sourceId: string, script: RenderSchedule.Script): RenderSchedule.ScriptReference Create a reference to a RenderSchedule.ScriptReference.script with the specified RenderSchedule.ScriptReference.sourceId.  
constructor(sourceIdOrScript: string | RenderSchedule.Script, scriptIfSourceId?: RenderSchedule.Script): RenderSchedule.ScriptReference Use one of the public constructor overloads which forward to this one.  

Properties

Name Type Description
script Readonly RenderSchedule.Script The script defining the rendering timelines to be applied.  
sourceId Readonly string The Id of the element - if any - from which the script originated.  

Defined in

Last Updated: 28 October, 2024