44 lines
1.1 KiB
JavaScript
44 lines
1.1 KiB
JavaScript
/**
|
|
* @module ol/colorlike
|
|
*/
|
|
import {toString} from './color.js';
|
|
|
|
|
|
/**
|
|
* A type accepted by CanvasRenderingContext2D.fillStyle
|
|
* or CanvasRenderingContext2D.strokeStyle.
|
|
* Represents a color, pattern, or gradient. The origin for patterns and
|
|
* gradients as fill style is the top-left corner of the extent of the geometry
|
|
* being filled.
|
|
*
|
|
* @typedef {string|CanvasPattern|CanvasGradient} ColorLike
|
|
* @api
|
|
*/
|
|
|
|
|
|
/**
|
|
* @param {module:ol/color~Color|module:ol/colorlike~ColorLike} color Color.
|
|
* @return {module:ol/colorlike~ColorLike} The color as an {@link ol/colorlike~ColorLike}.
|
|
* @api
|
|
*/
|
|
export function asColorLike(color) {
|
|
if (isColorLike(color)) {
|
|
return /** @type {string|CanvasPattern|CanvasGradient} */ (color);
|
|
} else {
|
|
return toString(/** @type {module:ol/color~Color} */ (color));
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @param {?} color The value that is potentially an {@link ol/colorlike~ColorLike}.
|
|
* @return {boolean} The color is an {@link ol/colorlike~ColorLike}.
|
|
*/
|
|
export function isColorLike(color) {
|
|
return (
|
|
typeof color === 'string' ||
|
|
color instanceof CanvasPattern ||
|
|
color instanceof CanvasGradient
|
|
);
|
|
}
|