ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Module types for ol/geom

Browse Source
This commit is contained in:
Tim Schaub
2018-03-11 23:08:50 -06:00
parent 41d9a84a8f
commit ef70d71636
60 changed files with 482 additions and 482 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/style/Style.js
+8 -8
View File
@@ -24,7 +24,7 @@ const Style = function(opt_options) {
/**
* @private
* @type {string|ol.geom.Geometry|ol.StyleGeometryFunction}
* @type {string|module:ol/geom/Geometry~Geometry|ol.StyleGeometryFunction}
*/
this.geometry_ = null;
@@ -122,7 +122,7 @@ Style.prototype.setRenderer = function(renderer) {
/**
* Get the geometry to be rendered.
* @return {string|ol.geom.Geometry|ol.StyleGeometryFunction}
* @return {string|module:ol/geom/Geometry~Geometry|ol.StyleGeometryFunction}
* Feature property or geometry or function that returns the geometry that will
* be rendered with this style.
* @api
@@ -236,7 +236,7 @@ Style.prototype.getZIndex = function() {
/**
* Set a geometry that is rendered instead of the feature's geometry.
*
* @param {string|ol.geom.Geometry|ol.StyleGeometryFunction} geometry
* @param {string|module:ol/geom/Geometry~Geometry|ol.StyleGeometryFunction} geometry
* Feature property or geometry or function returning a geometry to render
* for this style.
* @api
@@ -246,13 +246,13 @@ Style.prototype.setGeometry = function(geometry) {
this.geometryFunction_ = geometry;
} else if (typeof geometry === 'string') {
this.geometryFunction_ = function(feature) {
return /** @type {ol.geom.Geometry} */ (feature.get(geometry));
return /** @type {module:ol/geom/Geometry~Geometry} */ (feature.get(geometry));
};
} else if (!geometry) {
this.geometryFunction_ = defaultGeometryFunction;
} else if (geometry !== undefined) {
this.geometryFunction_ = function() {
return /** @type {ol.geom.Geometry} */ (geometry);
return /** @type {module:ol/geom/Geometry~Geometry} */ (geometry);
};
}
this.geometry_ = geometry;
@@ -346,10 +346,10 @@ export function createDefaultStyle(feature, resolution) {
/**
* Default styles for editing features.
* @return {Object.<ol.geom.GeometryType, Array.<ol.style.Style>>} Styles
* @return {Object.<module:ol/geom/GeometryType~GeometryType, Array.<ol.style.Style>>} Styles
*/
export function createEditingStyle() {
/** @type {Object.<ol.geom.GeometryType, Array.<ol.style.Style>>} */
/** @type {Object.<module:ol/geom/GeometryType~GeometryType, Array.<ol.style.Style>>} */
const styles = {};
const white = [255, 255, 255, 1];
const blue = [0, 153, 255, 1];
@@ -419,7 +419,7 @@ export function createEditingStyle() {
* Function that is called with a feature and returns its default geometry.
* @param {ol.Feature|ol.render.Feature} feature Feature to get the geometry
* for.
* @return {ol.geom.Geometry|ol.render.Feature|undefined} Geometry to render.
* @return {module:ol/geom/Geometry~Geometry|ol.render.Feature|undefined} Geometry to render.
*/
function defaultGeometryFunction(feature) {
return feature.getGeometry();
src/ol/style/TextPlacement.js
+3 -3
View File
@@ -4,9 +4,9 @@
/**
* Text placement. One of `'point'`, `'line'`. Default is `'point'`. Note that
* `'line'` requires the underlying geometry to be a {@link ol.geom.LineString},
* {@link ol.geom.Polygon}, {@link ol.geom.MultiLineString} or
* {@link ol.geom.MultiPolygon}.
* `'line'` requires the underlying geometry to be a {@link module:ol/geom/LineString~LineString},
* {@link module:ol/geom/Polygon~Polygon}, {@link module:ol/geom/MultiLineString~MultiLineString} or
* {@link module:ol/geom/MultiPolygon~MultiPolygon}.
* @enum {string}
*/
export default {
src/ol/style/index.jsdoc
+12 -12
View File
@@ -28,16 +28,16 @@
* var white = [255, 255, 255, 1];
* var blue = [0, 153, 255, 1];
* var width = 3;
* styles[ol.geom.GeometryType.POLYGON] = [
* styles[module:ol/geom/GeometryType~GeometryType.POLYGON] = [
* new ol.style.Style({
* fill: new ol.style.Fill({
* color: [255, 255, 255, 0.5]
* })
* })
* ];
* styles[ol.geom.GeometryType.MULTI_POLYGON] =
* styles[ol.geom.GeometryType.POLYGON];
* styles[ol.geom.GeometryType.LINE_STRING] = [
* styles[module:ol/geom/GeometryType~GeometryType.MULTI_POLYGON] =
* styles[module:ol/geom/GeometryType~GeometryType.POLYGON];
* styles[module:ol/geom/GeometryType~GeometryType.LINE_STRING] = [
* new ol.style.Style({
* stroke: new ol.style.Stroke({
* color: white,
@@ -51,9 +51,9 @@
* })
* })
* ];
* styles[ol.geom.GeometryType.MULTI_LINE_STRING] =
* styles[ol.geom.GeometryType.LINE_STRING];
* styles[ol.geom.GeometryType.POINT] = [
* styles[module:ol/geom/GeometryType~GeometryType.MULTI_LINE_STRING] =
* styles[module:ol/geom/GeometryType~GeometryType.LINE_STRING];
* styles[module:ol/geom/GeometryType~GeometryType.POINT] = [
* new ol.style.Style({
* image: new ol.style.Circle({
* radius: width * 2,
@@ -68,11 +68,11 @@
* zIndex: Infinity
* })
* ];
* styles[ol.geom.GeometryType.MULTI_POINT] =
* styles[ol.geom.GeometryType.POINT];
* styles[ol.geom.GeometryType.GEOMETRY_COLLECTION] =
* styles[ol.geom.GeometryType.POLYGON].concat(
* styles[ol.geom.GeometryType.POINT]
* styles[module:ol/geom/GeometryType~GeometryType.MULTI_POINT] =
* styles[module:ol/geom/GeometryType~GeometryType.POINT];
* styles[module:ol/geom/GeometryType~GeometryType.GEOMETRY_COLLECTION] =
* styles[module:ol/geom/GeometryType~GeometryType.POLYGON].concat(
* styles[module:ol/geom/GeometryType~GeometryType.POINT]
* );
*```
*