@eclipse-scout/core/dist/d.ts/src/util/icons.d.ts

Eclipse Scout runtime

import { IconDesc } from '../index';
export declare const icons: {
    TABLE_SORT_ASC: string;
    TABLE_SORT_DESC: string;
    EXCLAMATION_MARK_BOLD: string;
    EXCLAMATION_MARK_CIRCLE: string;
    INFO: string;
    CALENDAR: string;
    FILE: string;
    CLOCK: string;
    CHECKED_BOLD: string;
    GROUP: string;
    GROUP_PLUS: string;
    ANGLE_DOUBLE_LEFT: string;
    ANGLE_DOUBLE_RIGHT: string;
    ANGLE_LEFT: string;
    ANGLE_RIGHT: string;
    ANGLE_DOWN: string;
    ANGLE_UP: string;
    LONG_ARROW_DOWN: string;
    LONG_ARROW_UP: string;
    LONG_ARROW_DOWN_PLUS: string;
    LONG_ARROW_UP_PLUS: string;
    MINUS: string;
    PLUS: string;
    LIST: string;
    TARGET: string;
    WORLD: string;
    CHART: string;
    GEAR: string;
    STAR: string;
    STAR_MARKED: string;
    STAR_BOLD: string;
    STAR_SOLID: string;
    PERSON_SOLID: string;
    SEARCH: string;
    FOLDER: string;
    SUM: string;
    AVG: string;
    MAX: string;
    MAX_BOLD: string;
    MIN: string;
    MIN_BOLD: string;
    EXPAND_ALL: string;
    COLLAPSE_ALL: string;
    COLLAPSE: string;
    ELLIPSIS_V: string;
    SLIPPERY: string;
    REMOVE: string;
    REMOVE_BOLD: string;
    PENCIL: string;
    PENCIL_UNDERLINE_SOLID: string;
    ROTATE_LEFT: string;
    ROTATE_RIGHT: string;
    HOURGLASS: string;
    DIAGRAM_AREA: string;
    DIAGRAM_BAR: string;
    DIAGRAM_BARS_HORIZONTAL: string;
    DIAGRAM_BARS_VERTICAL: string;
    DIAGRAM_DOUGHNUT: string;
    DIAGRAM_LINE: string;
    DIAGRAM_LINE_ANGULAR: string;
    DIAGRAM_LINE_SMOOTH: string;
    DIAGRAM_PIE: string;
    DIAGRAM_RADAR: string;
    DIAGRAM_SCATTER: string;
    OPTIMIZE_WIDTH: string;
    OPTIMIZE_WIDTHS: string;
    CHEVRON_LEFT_BOLD: string;
    CHEVRON_RIGHT_BOLD: string;
    CHEVRON_UP_BOLD: string;
    CHEVRON_DOWN_BOLD: string;
    ARROW_RIGHT_BOLD: string;
    PLUS_BOLD: string;
    MINUS_BOLD: string;
    SQUARE_BOLD: string;
    CARET_DOWN: string;
    CARET_UP: string;
    CARET_LEFT: string;
    CARET_RIGHT: string;
    ANGLE_LEFT_BOLD: string;
    ANGLE_RIGHT_BOLD: string;
    ANGLE_UP_BOLD: string;
    ANGLE_DOWN_BOLD: string;
    CIRCLE_BOLD: string;
    LONG_ARROW_DOWN_BOLD: string;
    LONG_ARROW_UP_BOLD: string;
    LONG_ARROW_LEFT_BOLD: string;
    LONG_ARROW_RIGHT_BOLD: string;
    ICON_ID_REGEX: RegExp;
    /**
     * Returns an {@link IconDesc} object with structured info contained in the iconId string.
     */
    parseIconId(iconId: string): IconDesc;
    /**
     * Resolves the value of an iconId property, where the value can be a reference to
     * an icon constant in these formats:
     *
     * - `${iconId:ANGLE_UP}` references the constant `scout.icons.ANGLE_UP`
     * - `${iconId:foo.BAR}` references the constant `foo.icons.BAR`
     *
     * If the specified namespace does not have an `icons` object, an error will be thrown.
     */
    resolveIconId(value: string): string;
    /**
     * Converts the value of the specified property from the form `'${iconId:...}'` into a resolved iconId.
     * The value remains unchanged if it does not match the {@linkplain icons#resolveIconId supported format}.
     *
     * @param object non-null object having an icon property which may contain an iconId
     * @param iconProperty name of the property on the given object which may contain an iconId. By default, `'iconId'` is used as property name.
     */
    resolveIconProperty(object: object, iconProperty?: string): void;
    /**
     * Converts the values of the specified properties from the form `'${iconId:...}'` into a resolved iconId.
     * a value remains unchanged if it does not match the {@linkplain icons#resolveIconId supported format}.
     *
     * @param object non-null object having an icon property which may contain an iconId
     * @param iconProperties names of the properties on the given object which may contain an iconId.
     */
    resolveIconProperties(object: object, iconProperties: string[]): void;
};
//# sourceMappingURL=icons.d.ts.map