Back to Website
Show / Hide Table of Contents

Class OverlayEffect

Package: @aurigma/design-atoms-model

Constructors

(constructor)(object)

Constructs a new instance of the OverlayEffect class

Declaration
constructor(object?: {
        color?: Color;
        opacity?: number;
        blendMode?: BlendMode;
    });
Parameters
Type Name Description
{ color?: Color; opacity?: number; blendMode?: BlendMode; } object

Properties

$_propertyChanged

Declaration
protected $_propertyChanged: EventWithSenderArg<OverlayEffect, string>;
Property Value
Type Description
EventWithSenderArg<OverlayEffect, string>

blendMode

Declaration
get blendMode(): BlendMode;

set blendMode(value: BlendMode);
Property Value
Type Description
BlendMode

color

Declaration
get color(): Color;

set color(value: Color);
Property Value
Type Description
Color

opacity

Declaration
get opacity(): number;

set opacity(value: number);
Property Value
Type Description
number

type

Declaration
type: string;
Property Value
Type Description
string

type

Declaration
static type: string;
Property Value
Type Description
string

Methods

addPropertyChanged(listener)

Declaration
addPropertyChanged(listener: (sender: OverlayEffect, eventArgs: string) => void): void;
Parameters
Type Name Description
(sender: OverlayEffect, eventArgs: string) => void listener
Returns
Type Description
void

clone()

Declaration
clone(): OverlayEffect;
Returns
Type Description
OverlayEffect

equals(object)

Declaration
equals(object: OverlayEffect): boolean;
Parameters
Type Name Description
OverlayEffect object
Returns
Type Description
boolean

equals(a, b)

Declaration
static equals(a: OverlayEffect, b: OverlayEffect): boolean;
Parameters
Type Name Description
OverlayEffect a
OverlayEffect b
Returns
Type Description
boolean

getSimplifiedObject()

Declaration
getSimplifiedObject(): {
        color: Color;
        blendMode: BlendMode;
        opacity: number;
    };
Returns
Type Description
{ color: Color; blendMode: BlendMode; opacity: number; }

removePropertyChanged(listener)

Declaration
removePropertyChanged(listener: (sender: OverlayEffect, eventArgs: string) => void): void;
Parameters
Type Name Description
(sender: OverlayEffect, eventArgs: string) => void listener
Returns
Type Description
void
Was this page helpful?
Thanks for your feedback!
Back to top Copyright © 2001–2025 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback