JAXA Earth API for JavaScript
    Preparing search index...

    Interface ColorMapObject

    An object used as the argument for ColorMap.

    interface ColorMapObject {
        min: number;
        max: number;
        colors?: string[] | Colors;
        nanColor?: string;
        deleteMin?: boolean;
        deleteMax?: boolean;
        log?: boolean;
        logOrigin?: number;
        step?: number;
    }
    Index

    Properties

    min max colors? nanColor? deleteMin? deleteMax? log? logOrigin? step?

    Properties

    min: number

    Specifies the lower bound of the numeric range.

    max: number

    Specifies the upper bound of the numeric range.

    colors?: string[] | Colors

    Specifies the colors. Either select from Colors or specify an array of color codes. A color code is in the form RRGGBB or RRGGBBAA. AA is the alpha component, representing 00 for transparent through FF for opaque. If omitted, it is treated as colors: ["000000", "ffffff"].

    // When selecting from Colors
    	colors: je.Colors.JET,

    // When specifying an array of color codes
    	colors: ["ff0000", "ffffff", "0000ffcc"],	// red -> white -> semi-transparent blue
    nanColor?: string

    Specifies, as a color code, the color used to fill pixels whose value is NaN due to missing data or similar reasons. If omitted, it is treated as transparent nanColor: "00000000".

    // When filling NaN pixels with red
    	nanColor: "ff0000",
    deleteMin?: boolean

    Specify true to make pixels with values smaller than the value specified in min transparent. If false, all pixels with values smaller than min are filled with the min color.

    deleteMax?: boolean

    Specify true to make pixels with values larger than the value specified in max transparent. If false, all pixels with values larger than max are filled with the max color.

    log?: boolean

    Specify true to use a logarithmic scale. If omitted, it is treated as false, resulting in an evenly spaced scale.

    logOrigin?: number

    Specifies the origin of the logarithmic scale.

    // When using a logarithmic scale from -10 to 1000
    	min: -10,
    	max: 1000,
    	log: true,
    	logOrigin: -10,
    step?: number

    The number of divisions used when creating a discrete color map instead of a gradient.

    Theme settings

    Member visibility

    On This Page

    Properties