@razi91/types-ol-ext
Version:
Type definitions for ol-ext
61 lines (60 loc) • 1.73 kB
TypeScript
import Feature from 'ol/Feature';
import { StyleLike } from 'ol/style/Style';
import { Size } from 'ol/size';
export default ol_legend_Item;
/**
* ol/legend/Item options
*/
export type olLegendItemOptions = {
/**
* row title
*/
title: string;
className: string;
/**
* a feature to draw on the legend
*/
feature?: Feature;
/**
* type geom to draw with the style or the properties if no feature is provided
*/
typeGeom?: string;
/**
* a set of properties to use with a style function
*/
properties?: any;
/**
* a style or a style function to use to draw the legend
*/
style: StyleLike;
size?: Size
margin?: number
};
/** ol/legend/Item options
* @typedef {Object} olLegendItemOptions
* @property {string} title row title
* @property {string} className
* @property {Feature} feature a feature to draw on the legend
* @property {string} typeGeom type geom to draw with the style or the properties if no feature is provided
* @property {Object} properties a set of properties to use with a style function
* @property {StyleLike} style a style or a style function to use to draw the legend
* @property {Size|undefined} size
* @property {number|undefined} margin
*/
/** A class for legend items
* @constructor
* @fires select
* @param {olLegendItemOptions} options
*/
declare class ol_legend_Item {
constructor(options?: olLegendItemOptions);
/** Set the legend title
* @param {string} title
*/
setTitle(title: string): void;
/** Get element
* @param {ol.size} size symbol size
* @callback onClick
*/
getElement(size: Size, onclick: any): HTMLElement | Text;
}