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

Type definitions for ol-ext

import type { Stroke } from 'ol/style'
import { RegularShape } from 'ol/style'
import type { Pixel } from 'ol/pixel'

export interface Options {
  kind?: 'default' | 'square' | 'circle' | 'anchored' | 'folio';
  crop?: boolean;
  radius?: number;
  shadow?: number;
  declutterMode?: 'obstacle' | 'none' | undefined
  stroke?: Stroke;
  src?: string;
  crossOrigin?: string;
  displacement?: number[];
  offsetX?: number;
  offsetY?: number;
  onload?: () => void;
  onerror?: () => void;
}

/**
 * @classdesc
 * Set Photo style for vector features.
 *
 * @constructor

 * @extends {RegularShape}
 * @api
 */
export default class Photo extends RegularShape {
  /**
   * @param {Options=} options
   *  @param { default | square | circle | anchored | folio } options.kind
   *  @param {boolean} options.crop crop within square, default is false
   *  @param {Number} options.radius symbol size
   *  @param {Number} [options.shadow=0] drop a shadow (the shadow width in pixel)
   *  @param {string} [options.declutterMode] Declutter mode "declutter" | "obstacle" | "none" | undefined
   *  @param {ol_style_Stroke} options.stroke
   *  @param {String} options.src image src
   *  @param {String} options.crossOrigin The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you want to access pixel data with the Canvas renderer.
   *  @param {Array<number>} [options.displacement] to use with ol > 6
   *  @param {number} [options.offsetX=0] Horizontal offset in pixels, deprecated use displacement with ol>6
   *  @param {number} [options.offsetY=0] Vertical offset in pixels, deprecated use displacement with ol>6
   *  @param {function} [options.onload] callback when image is loaded (to redraw the layer)#
   *  @param {function} [options.onerror] callback when image is on error (not loaded)
   */
  constructor(options?: Options);

  /** Set photo offset
   * @param {olPixel} offset
   */
  setOffset(offset: Pixel): void;

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

  /**
   * Get the image icon.
   * @param {number} pixelRatio Pixel ratio.
   * @return {HTMLCanvasElement} Image or Canvas element.
   * @api
   */
  getImage(pielratio: number): HTMLCanvasElement

  getChecksum(): string;

  /** Returns the photo image
   * @returns {HTMLImageElement}
   */
  getPhoto(): HTMLImageElement;
}