@adaptabletools/adaptable/src/View/UIHelper.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { CSSProperties } from 'react';
import { EditableConfigEntityState } from './Components/SharedProps/EditableConfigEntityState';
import { StatusColour } from '../AdaptableState/Common/Enums';
import { AdaptableStyle } from '../AdaptableState/Common/AdaptableStyle';
import { Schedule, Weekday } from '../AdaptableState/Common/Schedule';
import { AdaptableColumnDataType, AdaptableSystemIconName, AdaptableOptions } from '../types';
import { AdaptableAlert } from '../AdaptableState/Common/AdaptableAlert';
import { AdaptableMessageType } from '../AdaptableState/Common/AdaptableMessageType';
export declare const BLACK: string;
export declare const WHITE: string;
export declare const LIGHT_GRAY: string;
export declare const GRAY: string;
export declare const BROWN: string;
export declare const DARK_GREEN: string;
export declare const GREEN: string;
export declare const LIME_GREEN: string;
export declare const YELLOW: string;
export declare const LIGHT_YELLOW: string;
export declare const DARK_BLUE: string;
export declare const BLUE: string;
export declare const LIGHT_BLUE: string;
export declare const CYAN: string;
export declare const MAGENTA: string;
export declare const PURPLE: string;
export declare const DARK_RED: string;
export declare const RED: string;
export declare const LIGHT_RED: string;
export declare const ORANGE: string;
export declare function getHexForName(name: string): string;
export declare function getDefaultColors(): string[];
export declare function getEmptyConfigState(): EditableConfigEntityState;
export declare function getDescriptionForDataType(dataType: AdaptableColumnDataType): "number" | "date" | "text";
export declare function getPlaceholderForDataType(dataType: AdaptableColumnDataType): "Enter Value" | "Enter Number" | "Enter Date";
export declare function getModalContainer(adaptableOptions: AdaptableOptions, document: Document): HTMLElement;
export declare function IsEmptyStyle(style: AdaptableStyle): boolean;
export declare function IsNotEmptyStyle(style: AdaptableStyle): boolean;
export declare function getMessageTypeByStatusColour(statusColour: StatusColour): AdaptableMessageType;
export declare function getButtonToneByMessageType(messageType: AdaptableMessageType): 'success' | 'error' | 'neutral' | 'none' | 'warning' | 'info' | 'accent';
export declare function getGlyphByMessageType(messageType: AdaptableMessageType): AdaptableSystemIconName;
export declare function getColorByMessageType(messageType: AdaptableMessageType): string;
export declare function getStyleForStatusColour(statusColour: StatusColour): CSSProperties;
export declare function getStyleForMessageType(messageType: AdaptableMessageType): CSSProperties;
export declare function getGlyphForStatusColour(statusColour: StatusColour): string;
export declare function getGlyphForMessageType(messageType: AdaptableMessageType): string;
export declare function getButtonToneForMessageType(messageType: AdaptableMessageType): 'info' | 'warning' | 'error' | 'success';
export declare function getScheduleDescription(schedule: Schedule): string;
export declare function getWeekDayByIndex(dayOfWeek: number): Weekday;
export declare function getMessageTypeFromAdaptableAlerts(adaptableAlerts: AdaptableAlert[]): AdaptableMessageType;
export declare function getButtonColourForAdaptableAlerts(adaptableAlerts: AdaptableAlert[], messageTypeColor: string): string;
export declare function getButtonTextColourForArrayandMessageType(adaptableAlerts: AdaptableAlert[], messageType: AdaptableMessageType): string;
export declare function getButtonTextColourForMessageType(messageType: AdaptableMessageType): string;
export declare function getAdaptableToolPanelWidth(): number;
export declare function getSimpleButtonPaddingWidth(): number;
export declare function getCSSVariableValue(cssVariable: string): string | undefined;
export declare function setCSSVariableValue(cssVariable: string, value: string): void;
export declare function isBrowserDocumentAvailable(): boolean;
export declare const UIHelper: {
    getHexForName: typeof getHexForName;
    getDefaultColors: typeof getDefaultColors;
    getEmptyConfigState: typeof getEmptyConfigState;
    getDescriptionForDataType: typeof getDescriptionForDataType;
    getPlaceholderForDataType: typeof getPlaceholderForDataType;
    getModalContainer: typeof getModalContainer;
    IsEmptyStyle: typeof IsEmptyStyle;
    IsNotEmptyStyle: typeof IsNotEmptyStyle;
    getMessageTypeByStatusColour: typeof getMessageTypeByStatusColour;
    getGlyphByMessageType: typeof getGlyphByMessageType;
    getButtonToneByMessageType: typeof getButtonToneByMessageType;
    getStyleForStatusColour: typeof getStyleForStatusColour;
    getGlyphForStatusColour: typeof getGlyphForStatusColour;
    getButtonToneForMessageType: typeof getButtonToneForMessageType;
    getScheduleDescription: typeof getScheduleDescription;
    getWeekDayByIndex: typeof getWeekDayByIndex;
    getColorByMessageType: typeof getColorByMessageType;
    getGlyphForMessageType: typeof getGlyphForMessageType;
    getStyleForMessageType: typeof getStyleForMessageType;
    getMessageTypeFromAdaptableAlerts: typeof getMessageTypeFromAdaptableAlerts;
    getButtonColourForAdaptableAlerts: typeof getButtonColourForAdaptableAlerts;
    getButtonTextColourForArrayandMessageType: typeof getButtonTextColourForArrayandMessageType;
    getButtonTextColourForMessageType: typeof getButtonTextColourForMessageType;
    getCSSVariableValue: typeof getCSSVariableValue;
    setCSSVariableValue: typeof setCSSVariableValue;
    getAdaptableToolPanelWidth: typeof getAdaptableToolPanelWidth;
    isBrowserDocumentAvailable: typeof isBrowserDocumentAvailable;
    getSimpleButtonPaddingWidth: typeof getSimpleButtonPaddingWidth;
};
export default UIHelper;