Module type for ol.ProjectionLike

This commit is contained in:
Frederic Junod
2018-03-19 10:38:39 +01:00
parent 634fb9f93b
commit 61f944d4a9
5 changed files with 9 additions and 9 deletions

View File

@@ -25,7 +25,7 @@ const COORDINATE_FORMAT = 'coordinateFormat';
* @typedef {Object} Options * @typedef {Object} Options
* @property {string} [className='ol-mouse-position'] CSS class name. * @property {string} [className='ol-mouse-position'] CSS class name.
* @property {module:ol/coordinate~CoordinateFormat} [coordinateFormat] Coordinate format. * @property {module:ol/coordinate~CoordinateFormat} [coordinateFormat] Coordinate format.
* @property {ol.ProjectionLike} projection Projection. * @property {module:ol/proj~ProjectionLike} projection Projection.
* @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the * @property {function(module:ol/MapEvent~MapEvent)} [render] Function called when the
* control should be re-rendered. This is called in a `requestAnimationFrame` * control should be re-rendered. This is called in a `requestAnimationFrame`
* callback. * callback.

View File

@@ -8,14 +8,14 @@ import {get as getProjection, equivalent as equivalentProjection, transformExten
/** /**
* @typedef {Object} ReadOptions * @typedef {Object} ReadOptions
* @property {ol.ProjectionLike} dataProjection Projection of the data we are reading. * @property {module:ol/proj~ProjectionLike} dataProjection Projection of the data we are reading.
* If not provided, the projection will be derived from the data (where possible) or * If not provided, the projection will be derived from the data (where possible) or
* the `defaultDataProjection` of the format is assigned (where set). If the projection * the `defaultDataProjection` of the format is assigned (where set). If the projection
* can not be derived from the data and if no `defaultDataProjection` is set for a format, * can not be derived from the data and if no `defaultDataProjection` is set for a format,
* the features will not be reprojected. * the features will not be reprojected.
* @property {module:ol/extent~Extent} extent Tile extent of the tile being read. This is only used and * @property {module:ol/extent~Extent} extent Tile extent of the tile being read. This is only used and
* required for {@link ol.format.MVT}. * required for {@link ol.format.MVT}.
* @property {ol.ProjectionLike} featureProjection Projection of the feature geometries * @property {module:ol/proj~ProjectionLike} featureProjection Projection of the feature geometries
* created by the format reader. If not provided, features will be returned in the * created by the format reader. If not provided, features will be returned in the
* `dataProjection`. * `dataProjection`.
*/ */
@@ -23,11 +23,11 @@ import {get as getProjection, equivalent as equivalentProjection, transformExten
/** /**
* @typedef {Object} WriteOptions * @typedef {Object} WriteOptions
* @property {ol.ProjectionLike} dataProjection Projection of the data we are writing. * @property {module:ol/proj~ProjectionLike} dataProjection Projection of the data we are writing.
* If not provided, the `defaultDataProjection` of the format is assigned (where set). * If not provided, the `defaultDataProjection` of the format is assigned (where set).
* If no `defaultDataProjection` is set for a format, the features will be returned * If no `defaultDataProjection` is set for a format, the features will be returned
* in the `featureProjection`. * in the `featureProjection`.
* @property {ol.ProjectionLike} featureProjection Projection of the feature geometries * @property {module:ol/proj~ProjectionLike} featureProjection Projection of the feature geometries
* that will be serialized by the format writer. If not provided, geometries are assumed * that will be serialized by the format writer. If not provided, geometries are assumed
* to be in the `dataProjection` if that is set; in other words, they are not transformed. * to be in the `dataProjection` if that is set; in other words, they are not transformed.
* @property {boolean} [rightHanded] When writing geometries, follow the right-hand * @property {boolean} [rightHanded] When writing geometries, follow the right-hand

View File

@@ -22,9 +22,9 @@ import {get as getProjection} from '../proj.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {ol.ProjectionLike} defaultDataProjection Default data projection. * @property {module:ol/proj~ProjectionLike} defaultDataProjection Default data projection.
* Default is `EPSG:4326`. * Default is `EPSG:4326`.
* @property {ol.ProjectionLike} featureProjection Projection for features read or * @property {module:ol/proj~ProjectionLike} featureProjection Projection for features read or
* written by the format. Options passed to read or write methods will take precedence. * written by the format. Options passed to read or write methods will take precedence.
* @property {string|undefined} geometryName Geometry name to use when creating features. * @property {string|undefined} geometryName Geometry name to use when creating features.
* @property {boolean|undefined} extractGeometryName Certain GeoJSON providers include * @property {boolean|undefined} extractGeometryName Certain GeoJSON providers include

View File

@@ -16,7 +16,7 @@ import {get as getProjection} from '../proj.js';
/** /**
* @typedef {Object} Options * @typedef {Object} Options
* @property {ol.ProjectionLike} defaultDataProjection Default data projection. * @property {module:ol/proj~ProjectionLike} defaultDataProjection Default data projection.
* Default is `EPSG:4326`. * Default is `EPSG:4326`.
* @property {string|undefined} layerName Set the name of the TopoJSON topology * @property {string|undefined} layerName Set the name of the TopoJSON topology
* `objects`'s children as feature property with the specified name. This means * `objects`'s children as feature property with the specified name. This means

View File

@@ -20,7 +20,7 @@ import {get as getProjection} from '../proj.js';
* they are dropped on the target. If you want to add features to a vector * they are dropped on the target. If you want to add features to a vector
* source without removing the existing features (append only), instead of * source without removing the existing features (append only), instead of
* providing the source option listen for the "addfeatures" event. * providing the source option listen for the "addfeatures" event.
* @property {ol.ProjectionLike} projection Target projection. By default, the map's view's projection is used. * @property {module:ol/proj~ProjectionLike} projection Target projection. By default, the map's view's projection is used.
* @property {Element|undefined} target The element that is used as the drop target, default is the viewport element. * @property {Element|undefined} target The element that is used as the drop target, default is the viewport element.
*/ */