smart-webcomponents-angular
Version:
[](https://jqwidgets.com/license/)
162 lines (161 loc) • 12.3 kB
TypeScript
import { ColorPanel } from './../index';
import { Animation, ColorApplyValueMode, ColorDisplayMode, ColorPalette, ColorTooltipDisplayMode, ColorValueFormat } from './../index';
import { AfterViewInit, ElementRef, OnInit, OnChanges, OnDestroy, SimpleChanges, EventEmitter } from '@angular/core';
import { BaseElement } from './smart.element';
import { ControlValueAccessor } from '@angular/forms';
import * as i0 from "@angular/core";
export { Animation, ColorApplyValueMode, ColorDisplayMode, ColorPalette, ColorTooltipDisplayMode, ColorValueFormat, ElementRenderMode } from './../index';
export { Smart } from './smart.element';
export { ColorPanel } from './../index';
export declare class ColorPanelComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges, ControlValueAccessor {
constructor(ref: ElementRef<ColorPanel>);
private eventHandlers;
nativeElement: ColorPanel;
/** @description Creates the component on demand.
* @param properties An optional object of properties, which will be added to the template binded ones.
*/
createComponent(properties?: {}): any;
/**
* @description
* The registered callback function called when a change event occurs on the form elements.
*/
_onChange: (value: any) => void;
/**
* @description
* The registered callback function called when a blur event occurs on the form elements.
*/
_onTouched: () => any;
/** @description Sets or gets the animation mode. Animation is disabled when the property is set to 'none' */
get animation(): Animation | string;
set animation(value: Animation | string);
/** @description Specifies how the value is applied. */
get applyValueMode(): ColorApplyValueMode | string;
set applyValueMode(value: ColorApplyValueMode | string);
/** @description Defines the number of columns for the colors in displayModes 'grid', 'hexagonal' and 'spectrumGrid'. */
get columnCount(): number;
set columnCount(value: number);
/** @description Enables or disables the element. Disabled elements can not be interacted with. */
get disabled(): boolean;
set disabled(value: boolean);
/** @description Determines the colors that will be displayed and their layout. */
get displayMode(): ColorDisplayMode | string;
set displayMode(value: ColorDisplayMode | string);
/** @description By default clicking on color panel's preview container returns the color value to it's previous state. 'disableUndo' prevents this functionality. */
get disableUndo(): boolean;
set disableUndo(value: boolean);
/** @description Allows to edit the alpha(transparency) of the colors via an editor/slider in the following displayModes: 'palette', 'radial', 'hexagonal' */
get editAlphaChannel(): boolean;
set editAlphaChannel(value: boolean);
/** @description Allows to select a custom color via an editor popup. Custom color selection is available in modes that don't have this option by default, like: 'grid', 'default, 'spectrum grid'. */
get enableCustomColors(): boolean;
set enableCustomColors(value: boolean);
/** @description Defines an Array of colors that will be used as the Theme Colors in the corresponding section in displayMode: 'default'. */
get gridThemeColors(): string[] | null;
set gridThemeColors(value: string[] | null);
/** @description Defines an Array of colors that will be used as the Shade Colors in the corresponding section of displayMode: 'default'. */
get gridShadeColors(): string[] | null;
set gridShadeColors(value: string[] | null);
/** @description Defines an Array of colors that will be used as the Standart Colors in the corresponding section of displayMode: 'default'. */
get gridStandardColors(): [] | null;
set gridStandardColors(value: [] | null);
/** @description Hides the alpha editor. Alpha editor is an input containing the value of the current color opacity. The input is available in the following modes: 'radial', 'palette', 'hexagonal'. The input is only visible if there's enough space. This editor is visible by default. */
get hideAlphaEditor(): boolean;
set hideAlphaEditor(value: boolean);
/** @description Determines which color editors will be hidden first when there's not enough space for all of them to be visible. By default the editors are only visible in 'palette', 'radial' and 'hexagonal' display modes. This property allows to prioritize the visibility of the editors. */
get hideContentToFit(): string[];
set hideContentToFit(value: string[]);
/** @description HEX editor is an input containing the hexadecimal representation of a color. This editor is visible by default. Setting 'hideRGBeditor' to true hides it. */
get hideHEXEditor(): boolean;
set hideHEXEditor(value: boolean);
/** @description Hides the preview container. Preview container is used to show the currently selected value in 'palette', 'radial' and 'hexagonal' display modes. */
get hidePreviewContainer(): boolean;
set hidePreviewContainer(value: boolean);
/** @description Hides the RGB editor. This editor is a group of three separate inputs for the Red, Green and Blue values of the color. */
get hideRGBEditor(): boolean;
set hideRGBEditor(value: boolean);
/** @description Inverts the colors in 'spectrumGrid', 'hexagonal', 'radial' modes. */
get inverted(): boolean;
set inverted(value: boolean);
/** @description Sets or gets the unlockKey which unlocks the product. */
get unlockKey(): string;
set unlockKey(value: string);
/** @description Sets or gets the language. Used in conjunction with the property messages. */
get locale(): string;
set locale(value: string);
/** @description Callback used to customize the format of the messages that are returned from the Localization Module. */
get localizeFormatFunction(): any;
set localizeFormatFunction(value: any);
/** @description Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. */
get messages(): any;
set messages(value: any);
/** @description Sets or gets the name attribute for the element. Name is used when submiting HTML forms. */
get name(): string;
set name(value: string);
/** @description Determines what colors will be displayed in 'spectrumGrid', 'grid' and 'hexagonal' displayModes. */
get palette(): ColorPalette | string;
set palette(value: ColorPalette | string);
/** @description Defines an array of colors that form a custom palette. This palette can be used in displayModes 'grid' and 'spectrum grid' if the palette property is set to custom. The value of the property can be an array of strings or objects that contain valid colors ( HEX, RGBA, etc). */
get paletteColors(): any;
set paletteColors(value: any);
/** @description Defines an array of colors that represent a predefined list of custom colors. This palette can be used in displayModes 'grid', 'default' and 'spectrum grid'. Custom colors are displayed at the bottom of the color grid below the button for custom color selection. They are only visible if enableCustomColors property is true. */
get paletteCustomColors(): string[] | null;
set paletteCustomColors(value: string[] | null);
/** @description If the element is readonly, users cannot interact with it. */
get readonly(): boolean;
set readonly(value: boolean);
/** @description Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. */
get rightToLeft(): boolean;
set rightToLeft(value: boolean);
/** @description Determines the theme. Theme defines the look of the element */
get theme(): string;
set theme(value: string);
/** @description Determines how the tooltip displays the value of the color that is being hovered. */
get tooltipDisplayMode(): ColorTooltipDisplayMode | string;
set tooltipDisplayMode(value: ColorTooltipDisplayMode | string);
/** @description Represents the value of the selected color. */
get value(): string;
set value(value: string);
/** @description Determines the format of the color. Whether it's in HEX, RGB or RGBA. By default it shows the color depending on the displayMode. */
get valueFormat(): ColorValueFormat | string;
set valueFormat(value: ColorValueFormat | string);
/** @description Determines the value member for the color when the paletteColors consists of objects. Usefull in cases where the colors are loaded as objects in an array and the attribute that holds the color key is not named 'value'. */
get valueMember(): string;
set valueMember(value: string);
/** @description If is set to true, the element cannot be focused. */
get unfocusable(): boolean;
set unfocusable(value: boolean);
/** @description This event is triggered when the color is changed.
* @param event. The custom event. Custom event was created with: event.detail( oldValue, value)
* oldValue - The previously selected color.
* value - The new selected color.
*/
onChange: EventEmitter<CustomEvent>;
/** @description This event is triggered when the cancel button is clicked. 'Cancel' button is visible only when applyValueMode is set to useButtons.
* @param event. The custom event. */
onCancelButtonClick: EventEmitter<CustomEvent>;
/** @description This event is triggered when the custom color selection view is opened/closed. Custom color selection view is available when enableCustomColors property is true.
* @param event. The custom event. Custom event was created with: event.detail( value)
* value - A boolean that indicates whether the custom color view is shown or not.
*/
onCustomColorSelection: EventEmitter<CustomEvent>;
/** @description This event is triggered when the ok button is clicked. 'Ok' button is visible only when applyValueMode is set to useButtons.
* @param event. The custom event. */
onOkButtonClick: EventEmitter<CustomEvent>;
get isRendered(): boolean;
ngOnInit(): void;
ngAfterViewInit(): void;
ngOnDestroy(): void;
_initialChange: boolean;
get ngValue(): any;
set ngValue(value: any);
writeValue(value: any): void;
registerOnChange(fn: any): void;
registerOnTouched(fn: any): void;
ngOnChanges(changes: SimpleChanges): void;
/** @description Add event listeners. */
private listen;
/** @description Remove event listeners. */
private unlisten;
static ɵfac: i0.ɵɵFactoryDeclaration<ColorPanelComponent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<ColorPanelComponent, "smart-color-panel, [smart-color-panel]", ["smart-color-panel"], { "animation": "animation"; "applyValueMode": "applyValueMode"; "columnCount": "columnCount"; "disabled": "disabled"; "displayMode": "displayMode"; "disableUndo": "disableUndo"; "editAlphaChannel": "editAlphaChannel"; "enableCustomColors": "enableCustomColors"; "gridThemeColors": "gridThemeColors"; "gridShadeColors": "gridShadeColors"; "gridStandardColors": "gridStandardColors"; "hideAlphaEditor": "hideAlphaEditor"; "hideContentToFit": "hideContentToFit"; "hideHEXEditor": "hideHEXEditor"; "hidePreviewContainer": "hidePreviewContainer"; "hideRGBEditor": "hideRGBEditor"; "inverted": "inverted"; "unlockKey": "unlockKey"; "locale": "locale"; "localizeFormatFunction": "localizeFormatFunction"; "messages": "messages"; "name": "name"; "palette": "palette"; "paletteColors": "paletteColors"; "paletteCustomColors": "paletteCustomColors"; "readonly": "readonly"; "rightToLeft": "rightToLeft"; "theme": "theme"; "tooltipDisplayMode": "tooltipDisplayMode"; "value": "value"; "valueFormat": "valueFormat"; "valueMember": "valueMember"; "unfocusable": "unfocusable"; }, { "onChange": "onChange"; "onCancelButtonClick": "onCancelButtonClick"; "onCustomColorSelection": "onCustomColorSelection"; "onOkButtonClick": "onOkButtonClick"; }, never>;
}