Skip to main content
Version: 2.9

UIBrick

@deprecated

use VisualBrick instead

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns UIBrick

Properties

readonlygetProperties

getProperties: () => string[]

Type declaration

    • (): string[]

    • Return the list of properties tags as an ordered array

      Returns string[]

staticcontainsRel

containsRel: Relation<CloudObject, CloudObject>

Relation between a container (a CloudObject) that has children (other CloudObjects)

For example, from a folder to the contained elements or from a function to the elements needed for that function to run.

staticextendRel

extendRel: Relation<CloudObject, CloudObject>

Model CloudObjects can inherit relations and properties from another CloudObject model to mimic their behaviour.

Relation from a model to the CloudObject model it extends. A --extendRel-> B A inherits B’s properties and relations.

staticextendedByRel

extendedByRel: Relation<CloudObject, CloudObject>

Inverse relation of extendRel

staticinstancesRel

instancesRel: Relation<CloudObject, CloudObject>

Inverse relation of modelRel between a model and its instances Equivalent to modelRel.getInverse()

staticmodelRel

modelRel: Relation<CloudObject, CloudObject>

Relation between a CloudObjectand its model instance --modelRel-> model

staticnameProp

nameProp: Property<string>

Name property for all CloudObjects

staticpropertyRel

propertyRel: Relation<CloudObject, PropertyModel>

Relation between a model and the properties it defines.

Methods

clear

  • Called every time the context is cleared.

    Parameters

    Returns void

destroy

  • Called when the brick ends its lifecycle and gets destroyed.

    Parameters

    Returns void

draw

  • Called when the DOM Element associated to that brick has been added to the document and is ready to be drawn.

    @deprecated

    override VisualBrick.render and VisualBrick.updateParent instead.

    Parameters

    • $: BrickContext

      the brick context

    • domElement: Element

      the associated DOM Element

    Returns any

equals

  • equals(object: any): boolean

  • Compare this CloudObject and the given one and return whether they are identical or not.

    Parameters

    • object: any

      the object to compare

    Returns boolean

    true if the specified object is the same CloudObject

follow

  • Start a query from this instance and follow the relation given as argument. The query starts from this single instance, and follows a relation to an arbitrary number of destination instances. See Query.follow(relation)

    The following are equivalent:

    myCloudObject.follow(relation);
    myCloudObject.query().follow(relation);

    Type parameters

    Parameters

    • relation: Relation<UIBrick, D>

      the relation to follow from the starting instance (this)

    Returns Query<D, never>

    query starting from this and following the relation relation as first step of the query

followSingle

  • Start a querySingle from this instance that follows 0..1 relations

    The query starts from this instance, and follow the relation to a single destination instance. It is equivalent to QuerySingle.from(this).follow(relation).

    Type parameters

    Parameters

    Returns QuerySingle<D>

    a query following 0-1 relations

get

  • Get the current value of the specified property for this CloudObject instance

    Type parameters

    • T

    Parameters

    Returns T

    property value

getInputs

  • getInputs(): string[]

  • Return the list of inputs tags as an ordered array.

    Returns string[]

getModel

  • Every CloudObject has a model which defines relations and properties its instances may have.

    Returns CloudObject

    the model of this CloudObject instance as a CloudObject instance

getModelTag

  • getModelTag(): string

  • Every CloudObject has a model which defines relations and properties its instances may have.

    Returns string

    the tag of the model of this CloudObject instance

getOutputs

  • getOutputs(): string[]

  • Return the list of outputs tags as an ordered array

    Returns string[]

getSource

  • getSource(): string

  • Return the source id that owns this cloud object.

    Returns string

getTag

  • getTag(): string

  • Every CloudObject has a unique tag.

    Returns string

    tag of the CloudObject

init

  • Called when the brick starts its lifecycle and gets initialized.

    Parameters

    Returns void

isPersisted

  • isPersisted(): boolean

  • Return the persistence state of this instance.

    CloudObjects can either be volatile, and only live in the local cache. In this case, the CloudObject instance is not persisted. If a CloudObjectis persisted, it is stored in an external data store. This means that the instance can be accessible through other Olympe VMs in the same environment.

    Returns boolean

    a boolean indicating if this object is persisted in a non-volatile way.

name

  • name(): string

  • Every CloudObject can define a value for its nameProperty. This method returns the current value of that property for this instance.

    Returns string

    the value of the name property of this

observe

  • Get an observable to the current value of the specified property for this CloudObject instance.

    The observable gets the new value each time the property gets updated in the datacloud. The observable gets completed automatically once the specified context is cleared. If waitForValue is set to FALSE (TRUE by default), the first value received by the observable is null if there is no value at call time.

    Type parameters

    • T

    Parameters

    • context: Context

      context to which the Observable is attached

    • property: InstanceOrTag | Property<T>

      property or property’s tag to observe

    • optionalwaitForValue: boolean

      whether the observable wait for a first value to get a value. (Default = true)

    Returns Observable<T>

    Observable of property values

observeProperties

  • Get an observable to pair [property, value] for this CloudObject instance.

    The observable gets the new value each time any property gets updated in the datacloud. The observable gets completed automatically once the specified context is cleared.

    Type parameters

    • T

    Parameters

    • context: Context

      Context to which the Observable will be attached

    Returns Observable<[Property<T>, T]>

    Observable of property values

onDestroy

  • @deprecated

    use Brick.destroy instead

    Parameters

    Returns void

onInit

  • @deprecated

    use Brick.init instead

    Parameters

    Returns void

onUpdate

  • onUpdate($: BrickContext, inputs: any[], outputs: (value: any) => void[]): void
  • @deprecated

    use Brick.update instead

    Parameters

    • $: BrickContext

      the brick context

    • inputs: any[]

      array of input values

    • outputs: (value: any) => void[]

      array of output setter functions.

    Returns void

query

  • Create and return a query starting from this instance

    Returns Query<UIBrick, never>

    a query starting at this CloudObject instance

render

  • Render an element for the given context. Can return null if no element is rendered.

    Parameters

    • $: BrickContext

      the brick context

    • properties: any[]

      property values that have been s

    Returns Element

    the rendered element

run

  • Run the brick itself using the specified context.

    Parameters

    Returns void

setupExecution

  • Observe the context to define when the brick update method should be called.

    Parameters

    Returns Observable<any>

    an observable that emit a value anytime the brick update method should be called.

toJSON

  • toJSON(): Object

  • Create a Javascript object from this CloudObject current state, including its tag and property values. It provides the same result as toObject called with nameAsKey = true and inheritedProperties = false.

    Returns Object

toObject

  • toObject(namesAsKey?: boolean, inheritedProperties?: boolean): Object

  • Create a Javascript object from this CloudObject current state.

    Parameters

    • optionalnamesAsKey: boolean

      If true, use the property name instead of the property tag as keys of the generated object.

    • optionalinheritedProperties: boolean

      If false, do not including inherited property. By default, it includes them.

    Returns Object

update

  • update($: BrickContext, inputs: any[], outputs: (any: any) => void[]): void | Promise<void>

  • Called whenever the conditions to update the brick are satisfied (as defined by method configCoreUpdate). By default, a function updates whenever an input gets a new value, but only if all inputs have a value.

    Parameters

    • $: BrickContext

      the brick context

    • inputs: any[]

      array of input values

    • outputs: (any: any) => void[]

      array of output setter functions. A setter updates a specific output value of the brick.

    Returns void | Promise<void>

updateParent

  • updateParent(parent: Element, element: Element): () => void

  • Attach the element rendered by render() to its parent (in the DOM). Must return the function to clear the parent from that element. That function is called just before the next call to updateParent.

    If the render() method returns null, only the clear function of previous call to updateParent() will be called.

    Parameters

    • parent: Element

      the parent element

    • element: Element

      the element to attach

    Returns () => void

    the function to clear the element from its parent.

      • (): void

      • Attach the element rendered by render() to its parent (in the DOM). Must return the function to clear the parent from that element. That function is called just before the next call to updateParent.

        If the render() method returns null, only the clear function of previous call to updateParent() will be called.

        Returns void

        the function to clear the element from its parent.

staticasInstance

  • asInstance<T>(this: Class<T>): T

  • Get this CloudObject class as a CloudObject instance.

    Type parameters

    • T

    Parameters

    Returns T

    the current data type class as a CloudObject instance.

staticcreateWith

  • Create an instance of the specified data type (or model) in the local datacloud (not persisted) with the specified property values.

    If the model is not specified, it uses this DataType.

    Type parameters

    • T

    Parameters

    • this: Class<T>
    • properties: Map<InstanceOrTag, any>

      mappings of (propertyTag -&gt; propertyValue)

    • optionalmodel: InstanceOrTag

      tag of the model of the CloudObject you want to create.

    • optionalsource: string

    Returns T

    newly created CloudObject

staticexists

  • Checks whether a CloudObject exists or not.

    @static

    Parameters

    Returns boolean

    true if tag is valid and references a CloudObject.

staticget

  • Get the CloudObject whose tag is specified.

    This only works if the CloudObject is already present in the local datacloud cache. (NB: you can use a Query to retrieve a distant CloudObject)

    @static

    Type parameters

    Parameters

    Returns T

    CloudObject specified by the tag

staticgetProperties

  • The attributes of a CloudObject are called properties. Properties can be of different types, e.g. Property<string>, Property<number>, Property<Date>.

    If a Person CloudObject has an age property, all the instances of Person can access the age property using the same tag, the tag of the age property. This method returns all properties defined by the Data Type associated to this class.

    Returns Property<any>[]

    All properties defined for a data type

staticgetRelations

  • Return all the relations whose origin OR destination is the CloudObject associated to this class.

    Type parameters

    Parameters

    Returns (Relation<O, D> | Relation<D, O>)[]

    All relations defined on the current data type. It can be the destination or the origin of the relations.

staticinstancesOf

  • Return a query starting from all instances of this Data Type.

    Type parameters

    Parameters

    Returns Query<T, never>

    A query starting from the instances of the specified model.