@siedlerchr/types-ol-ext/legend/Legend.d.ts

Type definitions for ol-ext

import type ol_Collection from 'ol/Collection'
import type { Style, Text } from 'ol/style'
import type { StyleFunction, StyleLike } from 'ol/style/Style'
import type { Size } from 'ol/size'
import type Layer from 'ol/layer/Layer'
import type ol_legend_Item from './Item'
import type { olLegendItemOptions } from './Item'
import type BaseObject from 'ol/Object';

export interface Options {
  title?: string;
  maxWidth?: number;
  size?: Size;
  margin?: number;
  layer?: Layer;
  textStyle?: Text;
  titleStyle?: Text;
  style?: StyleLike;
}

/** Legend class to draw features in a legend element
 * @constructor
 * @fires select
 * @fires refresh
 */
export default class ol_legend_Legend extends BaseObject {
  /** Get a symbol image for a given legend item
   * @param {olLegendItemOptions} item
   * @param {Canvas|undefined} canvas a canvas to draw in, if none creat one
   * @param {int|undefined} offsetY Y offset to draw in canvas, default 0
   */
  static getLegendImage(item: olLegendItemOptions, canvas?: HTMLCanvasElement | undefined, row?: number): HTMLCanvasElement;

  /**
   * @param {*} options
   *  @param {String} options.title Legend title
   *  @param {number} [options.maxWidth] maximum legend width
   *  @param {ol.size} [options.size] Size of the symboles in the legend, default [40, 25]
   *  @param {number} [options.margin=10] Size of the symbole's margin, default 10
   *  @param { ol.layer.Base } [layer] layer associated with the legend
   *  @param { ol.style.Text} [options.textStyle='16px sans-serif'] a text style for the legend, default 16px sans-serif
   *  @param { ol.style.Text} [options.titleStyle='bold 16px sans-serif'] a text style for the legend title, default textStyle + bold
   *  @param { ol.style.Style | Array<ol.style.Style> | ol.StyleFunction | undefined } options.style a style or a style function to use with features
   */
  constructor(options?: Options);

  /** Set legend title
   * @param {string} title
   */
  setTitle(title: string): void;

  /** Get legend title
   * @returns {string}
   */
  getTitle(): string;

  /** Get text Style
   * @returns {ol_style_Text}
   */
  getTextStyle(): Text;

  /** Set the layer associated with the legend
   * @param {ol.layer.Layer} [layer]
   */
  setLayer(layer: Layer): void

  /** Set legend size
   * @param {ol.size} size
   */
  set(size: Size): void;

  /** Get legend list element
   * @returns {Element}
   */
  getListElement(): Element;

  /** Get legend canvas
   * @returns {HTMLCanvasElement}
   */
  getCanvas(): HTMLCanvasElement;

  /** Set the style
   * @param { Style| Array<Style> | StyleFunction | undefined } style a style or a style function to use with features
   */
  setStyle(style: Style | Array<Style> | StyleFunction | undefined): void;

  /** Add a new item to the legend
   * @param {olLegendItemOptions|ol_legend_Item} item
   */
  addItem(item: olLegendItemOptions | ol_legend_Item): void;

  /** Get item collection
   * @param {ol_Collection}
   */
  getItems(): ol_Collection<ol_legend_Item>;

  /** Remove an item at index
   * @param {ol_legend_Item} item
   */
  removeItem(item: ol_legend_Item): void;

  /*
  * @param {number} index
  */
  removeItemAt(index: number): void;

  /** Refresh the legend
   */
  refresh(): void;

  /** Calculate the legend height
   * @return {number}
   */
  getHeight(): number;

  /** Calculate the legend width
   * @return {number}
   */
  getWidth(): number;

  /** Get the image for a style
   * @param {olLegendItemOptions} item
   * @param {Canvas|undefined} canvas a canvas to draw in, if none create one
   * @param {int|undefined} offsetY Y offset to draw in canvas, default 0
   * @return {CanvasElement}
   */
  getLegendImage(item: olLegendItemOptions, canvas?: HTMLCanvasElement, offsetY?: number): HTMLCanvasElement;

  // The following function is already declared in ol/Object.d.ts
  // but we still have to redeclare it here, otherwise it's being hidden
  // by set(size: Size), which is declared above.
  /**
   * Sets a value.
   * @param {string} key Key name.
   * @param {*} value Value.
   * @param {boolean} [opt_silent] Update without triggering an event.
   * @api
   */
  set(key: string, value: any, opt_silent?: boolean | undefined): void;
}