@siedlerchr/types-ol-ext/style/FillPattern.d.ts

Type definitions for ol-ext

import type { Image, Icon } from 'ol/style'
import { Fill } from 'ol/style'
import type { Color } from 'ol/color'
import type { ColorLike } from 'ol/colorlike'

export interface FillPatternOptions {
  size?: number;
  width?: number;
  height?: number;
  circles?: number[][];
  lines?: number[][];
  stroke?: number;
  fill?: boolean;
  char?: string;
  font?: string;
  angle?: boolean;
}

export interface Options {
  pattern?: string;
  image?: Image;
  ratio?: number,
  icon?: Icon
  opacity?: number;
  color?: Color | ColorLike;
  fill?: Fill;
  offset?: number | [number, number];
  size?: number;
  spacing?: number;
  angle?: number | boolean;
  scale?: number;
}

/**
 * @classdesc
 * Fill style with named pattern
 *
 * @constructor

 * @extends {Fill}
 * @api
 */
export default class FillPattern extends Fill {
  /**
   * @param {olx.style.FillPatternOption=}  options
   *  @param {Image|undefined} options.image an image pattern, image must be preloaded to draw on first call
   *  @param {number|undefined} options.opacity opacity with image pattern, default:1
   *  @param {string} options.pattern pattern name (override by image option)
   *  @param {Color|ColorLike} options.color pattern color
   *  @param {Fill} options.fill fill color (background)
   *  @param {number|Array<number>} options.offset pattern offset for hash/dot/circle/cross pattern
   *  @param {number} options.size line size for hash/dot/circle/cross pattern
   *  @param {number} options.spacing spacing for hash/dot/circle/cross pattern
   *  @param {number|boolean} options.angle angle for hash pattern / true for 45deg dot/circle/cross
   *  @param {number} options.scale pattern scale
   */
  constructor(options?: Options);

  /**
   * Clones the style.
   * @return {style.FillPattern}
   */
  clone(): FillPattern;

  /** Get canvas used as pattern
   *  @return {canvas}
   */
  getImage(): HTMLCanvasElement;

  /** Static fuction to add char patterns
   * @param {title}
   * @param {FillPatternOptions} options
   *  @param {integer} [options.size=10] default 10
   *  @param {integer} [options. width=10] default 10
   *  @param {integer} [options.height=10] default 10
   *  @param {Array<circles>} [options.circles]
   *  @param {Array<pointlist>} [options.lines]
   *  @param {integer} [options.stroke]
   *  @param {bool} [options.fill]
   *  @param {char} [option.char]
   *  @param {string} [font="10px Arial"]
   */
  static addPattern(title: string, options: FillPatternOptions): void;

  /** Patterns definitions
   * @see pattern generator http://www.imagico.de/map/jsdotpattern.php
   */
  static patterns: {
    hatch: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    cross: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    dot: {
      width: number;
      height: number;
      circles: number[][];
      stroke: boolean;
      fill: boolean;
    };
    circle: {
      width: number;
      height: number;
      circles: number[][];
      stroke: number;
      fill: boolean;
    };
    square: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
      fill: boolean;
    };
    tile: {
      width: number;
      height: number;
      lines: number[][];
      fill: boolean;
    };
    woven: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    crosses: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    caps: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    nylon: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    hexagon: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
      repeat: number[][];
    };
    cemetry: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
      repeat: number[][];
    };
    sand: {
      width: number;
      height: number;
      circles: number[][];
      fill: number;
    };
    conglomerate: {
      width: number;
      height: number;
      circles: number[][];
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    conglomerate2: {
      width: number;
      height: number;
      circles: number[][];
      lines: number[][];
      repeat: number[][];
      fill: number;
    };
    gravel: {
      width: number;
      height: number;
      circles: number[][];
      lines: number[][];
      stroke: number;
    };
    brick: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    dolomite: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    coal: {
      width: number;
      height: number;
      lines: number[][];
      fill: number;
    };
    breccia: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    clay: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    flooded: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    chaos: {
      width: number;
      height: number;
      lines: number[][];
      fill: number;
    };
    grass: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    swamp: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    reed: {
      width: number;
      height: number;
      lines: number[][];
      circles: number[][];
      repeat: number[][];
      stroke: number;
    };
    wave: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    vine: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
    forest: {
      width: number;
      height: number;
      circles: number[][];
      stroke: number;
    };
    forest2: {
      width: number;
      height: number;
      circles: number[][];
      fill: number;
      stroke: number;
    };
    scrub: {
      width: number;
      height: number;
      lines: number[][];
      circles: number[][];
      stroke: number;
    };
    tree: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    tree2: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      fill: number;
      stroke: number;
    };
    pine: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    pine2: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      fill: number;
      stroke: number;
    };
    mixtree: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    mixtree2: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      fill: number;
      stroke: number;
    };
    pines: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    rock: {
      width: number;
      height: number;
      lines: number[][];
      repeat: number[][];
      stroke: number;
    };
    rocks: {
      width: number;
      height: number;
      lines: number[][];
      stroke: number;
    };
  }
}