Class ColorPreviewService

Package: @aurigma/design-atoms

Constructors

(constructor)(apiClient, renderingConfigProvider)

Constructs a new instance of the ColorPreviewService class

Declaration

constructor(apiClient: IDesignAtomsApiClient, renderingConfigProvider: IRenderingConfigProvider);

Parameters

Type	Name	Description
IDesignAtomsApiClient	apiClient
IRenderingConfigProvider	renderingConfigProvider

Methods

getPreview(color)

Declaration

getPreview(color: Color): RgbColor | null;

Parameters

Type	Name	Description
Color	color

Returns

Type	Description
RgbColor | null

getPreviewAsync(color)

Declaration

getPreviewAsync(color: Color): Promise<RgbColor>;

Parameters

Type	Name	Description
Color	color

Returns

Type	Description
Promise<RgbColor>

getPreviews(colors)

Declaration

getPreviews(colors: Color[]): (RgbColor | null)[];

Parameters

Type	Name	Description
Color[]	colors

Returns

Type	Description
(RgbColor | null)[]

getPreviewsAsync(colors)

Declaration

getPreviewsAsync(colors: Color[]): Promise<RgbColor[]>;

Parameters

Type	Name	Description
Color[]	colors

Returns

Type	Description
Promise<RgbColor[]>

subscribeToPreviewLoaded(color, listener)

Declaration

subscribeToPreviewLoaded(color: Color, listener: (args: IPreviewLoadedEventArgs) => any): void;

Parameters

Type	Name	Description
Color	color
(args: IPreviewLoadedEventArgs) => any	listener

Returns

Type	Description
void

unsubscribeFromPreviewLoaded(color, listener)

Declaration

unsubscribeFromPreviewLoaded(color: Color, listener: (args: IPreviewLoadedEventArgs) => any): void;

Parameters

Type	Name	Description
Color	color
(args: IPreviewLoadedEventArgs) => any	listener

Returns

Type	Description
void