SetCustomValue Function

Replaces the auto-measured value of a given dimension item from an Envision document currently opened in the Canvas Envision Creator app with a given custom value.

SetCustomValue(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], value: string): Promise<void>

Parameters

obj: EvItem

An Object item object, a dimension item from the Envision document currently opened in the Canvas Envision Creator app whose auto-measured value should be replaced with the given custom value.

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

value: string

A string, a custom value that should replace the auto-measured value of the given dimension item.

If this parameter is not given, the auto-measured value remains unchanged.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given custom value has successfully replaced the auto-measured value of the given dimension item in the current document.

31 March 2025