@siedlerchr/types-ol-ext/source/DayNight.d.ts

Type definitions for ol-ext

import type { Options as VectorSourceOptions } from 'ol/source/Vector'
import VectorSource from 'ol/source/Vector'
import type { Point } from 'ol/geom'
import type Feature from 'ol/Feature'

export interface Options extends VectorSourceOptions<Feature> {
  time?: string | Date;
  step?: number;
}

/** DayNight source: a source to display day/night on a map
 * @constructor
 * @extends {ol.source.Vector}

 */
export default class DayNight extends VectorSource {
  /**
   * @param {any} options Vector source options
   *  @param {string|Date} time source date time
   *  @param {number} step step in degree for coordinate precision
   */
  constructor(options?: Options);

  /** Set source date time
   * @param {string|Date} time source date time
   */
  setTime(time: string | Date): void

  /** Get night-day separation line
   * @param {string} time DateTime string, default yet
   * @param {string} options use 'line' to get the separation line, 'day' to get the day polygon, 'night' to get the night polygon or 'daynight' to get both polygon, default 'night'
   * @return {Array<ol.Point>|Array<Array<ol.Point>>}
   */
  getCoordinates(time?: string, options?: 'line' | 'day' | 'night' | 'daynight'): Point[] | Point[][]
}