API Reference › core-backend› Elements › RenderTimeline

RenderTimeline Class @preview

Describes how to animate a view of a GeometricModel to show change over time using a RenderSchedule.Script.

@note This class was introduced in version 01.00.13 of the BisCore ECSchema. It should only be used with IModelDbs containing that version or newer.

Extends

Methods

Name Description
constructor(props: RenderTimelineProps, iModel: IModelDb): RenderTimeline Protected    
collectReferenceIds(ids: EntityReferenceSet): void Protected Collect the Ids of this entity's references at this level of the class hierarchy.  
toJSON(): RenderTimelineProps Obtain the JSON representation of this Entity.  
deserialize(props: DeserializeEntityArgs): RenderTimelineProps Static Converts an ECSqlRow of an Entity to an EntityProps.  
fromJSON(props: RenderTimelineProps, iModel: IModelDb): RenderTimeline Static    
remapScript(context: IModelElementCloneContext, input: RenderSchedule.ScriptProps): RenderSchedule.ScriptProps Static Remap Ids when cloning a RenderSchedule.Script between iModels on a DisplayStyle or RenderTimeline.  

Inherited methods

Name Inherited from Description
delete(txn: EditTxn): void Inherited InformationRecordElement Delete this Element from the iModel using the supplied EditTxn.
delete(): void Inherited InformationRecordElement Delete this Element from the iModel.
forEach(func: PropertyHandler, includeCustom: boolean = true): void Inherited InformationRecordElement Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Inherited InformationRecordElement Call a function for each property of this Entity.
getClassMetaData(): EntityMetaData | undefined Inherited InformationRecordElement Get the class metadata for this element.
getDisplayLabel(): string Inherited InformationRecordElement Get a display label for this Element.
getJsonProperty(nameSpace: string): any Inherited InformationRecordElement Get a JSON property of this element, by namespace
getMetaData(): Promise<EntityClass> Inherited InformationRecordElement Query metadata for this entity class from the iModel's schema.
getReferenceIds(): EntityReferenceSet Inherited InformationRecordElement Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] Inherited InformationRecordElement Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any Inherited InformationRecordElement Get a set of JSON user properties by namespace
insert(txn: EditTxn): string Inherited InformationRecordElement Insert this Element into the iModel using the supplied EditTxn.
insert(): string Inherited InformationRecordElement Insert this Element into the iModel.
removeUserProperties(nameSpace: string): void Inherited InformationRecordElement Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void Inherited InformationRecordElement  
setUserProperties(nameSpace: string, value: any): void Inherited InformationRecordElement Change a set of user JSON properties of this Element by namespace.
update(txn: EditTxn): void Inherited InformationRecordElement Update this Element in the iModel using the supplied EditTxn.
update(): void Inherited InformationRecordElement Update this Element in the iModel.
is(otherClass: Entity): boolean Static Inherited InformationRecordElement return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static Inherited InformationRecordElement Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
onAllInputsHandledArg(arg: OnElementDependencyArg): void Protected Static Inherited InformationRecordElement Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void Protected Static Inherited InformationRecordElement Called when a root element in a subgraph is changed and before its outputs are processed.
onBeforeOutputsHandledArg(arg: OnElementDependencyArg): void Protected Static Inherited InformationRecordElement Called when a root element in a subgraph is changed and before its outputs are processed.
onBulkChildDeleted(arg: OnBulkChildDeletedBatchArg): void Protected Static Inherited InformationRecordElement Called after a batch of child Elements of this class's instances were deleted in a bulk delete operation.
onBulkDeleted(arg: OnBulkDeletedBatchArg): void Protected Static Inherited InformationRecordElement Called after a batch of Elements of this class were deleted in a bulk delete operation.
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static Inherited InformationRecordElement Called when an existing element is about to be updated so that an instance of this class will become its new parent.
onChildAdded(arg: OnChildElementIdArg): void Protected Static Inherited InformationRecordElement Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void Protected Static Inherited InformationRecordElement Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(arg: OnChildElementIdArg): void Protected Static Inherited InformationRecordElement Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void Protected Static Inherited InformationRecordElement Called when an element with an instance of this class as its parent is about to be updated change to a different parent.
onChildDropped(arg: OnChildElementIdArg): void Protected Static Inherited InformationRecordElement Called after an element with an instance of this class as its previous parent was updated to have a new parent.
onChildInsert(_arg: OnChildElementPropsArg): void Protected Static Inherited InformationRecordElement Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(arg: OnChildElementIdArg): void Protected Static Inherited InformationRecordElement Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static Inherited InformationRecordElement Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(arg: OnChildElementIdArg): void Protected Static Inherited InformationRecordElement Called after an element with an instance of this the class as its parent was updated.
onDelete(arg: OnElementIdArg): void Protected Static Inherited InformationRecordElement Called before an Element is deleted.
onDeleted(arg: OnElementIdArg): void Protected Static Inherited InformationRecordElement Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void Protected Static Inherited InformationRecordElement Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void Protected Static Inherited InformationRecordElement Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static Inherited InformationRecordElement Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(arg: OnSubModelIdArg): void Protected Static Inherited InformationRecordElement Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(arg: OnSubModelPropsArg): void Protected Static Inherited InformationRecordElement Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(arg: OnSubModelIdArg): void Protected Static Inherited InformationRecordElement Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void Protected Static Inherited InformationRecordElement Called before an Element is updated.
onUpdated(arg: OnElementIdArg): void Protected Static Inherited InformationRecordElement Called after an Element was updated.
serialize(props: ElementProps, iModel: IModelDb): ECSqlRow Static Inherited InformationRecordElement Converts an EntityProps to an ECSqlRow.

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  
description string A human-readable description of the timeline, which may be an empty string.  
scriptProps RenderSchedule.ScriptProps The JSON representation of the instructions for visualizing change over time.  

Inherited properties

Name Type Inherited from Description
_customHandledProps Protected Static Readonly Inherited CustomHandledProperty[] InformationRecordElement List of properties that are need to be custom handled during deserialization and serialization.
_metadata Protected Inherited EntityClass | RelationshipClass InformationRecordElement Cached Metadata for the ECClass
allowedSubModelClasses Accessor Protected Static Inherited ReadOnly EntityClassType<Model>[] | undefined InformationRecordElement The Model classes that may sub-model an instance of this class.
A sub-model is accepted if its class is, or derives from, one of these classes, including generated JavaScript classes for unregistered EC subclasses.
The default is undefined, which permits any Model class.
Domain classes implementing bis:ISubModeledElement should override this to restrict their sub-model class.
classFullName Accessor Inherited ReadOnly string InformationRecordElement Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string InformationRecordElement Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string InformationRecordElement The name of the BIS class associated with this class.
code Inherited Code InformationRecordElement The Code for this element
federationGuid Inherited string | undefined InformationRecordElement A FederationGuid assigned to this element by some other federated database
id Inherited string InformationRecordElement The Id of this Entity.
iModel Inherited IModelDb InformationRecordElement The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" InformationRecordElement An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
jsonProperties Readonly Inherited [key: string]: any InformationRecordElement Optional json properties of this element.
model Readonly Inherited string InformationRecordElement The ModelId of the Model containing this element
parent Inherited RelatedElement | undefined InformationRecordElement The parent element, if present, of this element.
requiredReferenceKeys Static Readonly Inherited ReadonlyArray InformationRecordElement A required reference is an element that had to be inserted before this element could have been inserted.
schema Static Inherited Schema InformationRecordElement The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey InformationRecordElement Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey InformationRecordElement Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string InformationRecordElement The name of the BIS Schema that defines this class
userLabel Inherited string | undefined InformationRecordElement A user-assigned label for this element.

Defined in

Last Updated: 12 October, 2026