SetQRString Function

Replaces the payload encoded in a given QR code item from an Envision document currently opened in the Canvas Envision Creator app with a given string.

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

Parameters

obj: EvItem

An Object item object, a QR code item from the Envision document currently opened in the Canvas Envision Creator app whose encoded payload should be replaced with the given string.

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

qrstring: string

A string, the new payload that should be encoded in the given QR code item.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the encoded payload of the given QR code item in the current document has been successfully replaced with the given string.

09 April 2025