SetTransparency Function

Manages the transparency of a given object item from an Envision document currently opened in the Canvas Envision Creator app.

    SetTransparency(
        obj: [[[EvItem|canvas-envision-document-items.html#object-items]]],
        percentage: number,
        mode?: [[[EvTrspBlendMode|evtrspblendmode-enumeration.html]]],
        area?: [[[EvTransparencyArea|evtransparencyarea-enumeration.html]]]
    ): Promise<void>

Parameters

obj: EvItem

An Object item object, an object item from the Envision document currently opened in the Canvas Envision Creator app whose transparency should be updated.

percentage: number

A number, a value from 0 to 100 that defines how transparent a given object item should be:

0: fully opaque.
100: fully transparent.

mode?: EvTrspBlendMode

A member of the EvTrspBlendMode enumeration, the blend mode that should be used for drawing the transparency effect.

The default value is "normal".

area?: EvTransparencyArea

A member of the EvTransparencyArea enumeration, parts of a given object item that should be affected by transparency updates.

The default value is "fill_only".

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the transparency of the given object item has been successfully updated.

27 March 2025