UpdateConfigurationProperties Function

Adds new gadget configuration properties to a given gadget item or updates gadget configuration properties already existing in the given gadget item from an Envision document currently opened in the Canvas Envision Creator app.

    UpdateConfigurationProperties(
        obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], 
        configProperties: [[[EvGadgetConfigProperty|evgadgetconfigproperty-interface.html]]][]
    ): Promise<void>

Parameters

obj: EvItem

An Object item object, a gadget item from the Envision document currently opened in the Canvas Envision Creator app to which the given new gadget configuration properties should be added or whose given existing gadget configuration properties should be updated.

If a given object item is not a gadget, the function throws an error.

configProperties: EvGadgetConfigProperty[]

An array of EvGadgetConfigProperty objects, the gadget configuration properties of the given gadget item that should be added or updated.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given gadget configuration properties of the given gadget item have been successfully added or updated.

Discussion

If the given gadget item already has a gadget configuration property included in the array passed in the configProperties parameter, the value of this gadget configuration property is updated in the given gadget item. If the given gadget item does not have a gadget configuration property included in the array, this gadget configuration property is added as a new one to the given gadget item. If the array does not include a gadget configuration property that the given gadget item has, the value of this gadget configuration property remains unchanged in the given gadget item.

04 April 2025