NativeScript/color/color.d.ts

/**
 * Allows creating colors to be used when styling the UI.
 */
declare module "color" {
    /**
     * Represents a color object. Stores all color components (alpha (opacity), red, green, blue) in a [0..255] range.
     */
    class Color {
        constructor(knownColor: string);
        constructor(hex: string);
        constructor(argb: number);
        constructor(alpha: number, red: number, green: number, blue: number);

        /**
         * Gets the Alpha component (in the [0, 255] range) of this color. This is a read-only property.
         */
        public a: number;

        /**
         * Gets the Red component (in the [0, 255] range) of this color. This is a read-only property.
         */
        public r: number;

        /**
         * Gets the Green component (in the [0, 255] range) of this color. This is a read-only property.
         */
        public g: number;

        /**
         * Gets the Blue component (in the [0, 255] range) of this color. This is a read-only property.
         */
        public b: number;

        /**
         * Gets the Hexadecimal string representation of this color. This is a read-only property.
         */
        public hex: string;

        /**
         * Gets the Argb Number representation of this color where each 8 bits represent a single color component. This is a read-only property.
         */
        public argb: number;

        /**
         * Gets the known name of this instance. Defined only if it has been constructed from a known color name - e.g. "red". This is a read-only property.
         */
        public name: string;

        /**
         * Gets the android-specific integer value representation. Same as the Argb one. This is a read-only property.
         */
        android: number;

        /**
         * Gets the iOS-specific UIColor value representation. This is a read-only property.
         */
        ios: any /* UIColor */;

        /**
         * Specifies whether this Color is equal to the Color parameter.
         * @param value The Color to test.
         */
        public equals(value: Color): boolean;

        /**
         * Compares two Color instances.
         * @param value1 A Color to compare.
         * @param value2 A Color to compare.
         */
        public static equals(value1: Color, value2: Color): boolean;

        /**
         * Validates if a value can be converted to color.
         * @param value Input string.
         */
        public static isValid(value: any): boolean;
    }
}