diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc index f6fba884dc..72b96d01cd 100644 --- a/src/objectliterals.jsdoc +++ b/src/objectliterals.jsdoc @@ -118,7 +118,7 @@ * @property {ol.Coordinate|undefined} center The initial center for the view. * The coordinate system for the center is specified with the `projection` * option. Default is `undefined`, and layer sources will not be fetched if - * this is not set. + * this is not set. * @property {ol.Extent|undefined} extent The extent that constrains the center, * in other words, center cannot be set outside this extent. * Default is `undefined`. @@ -205,12 +205,12 @@ /** * @typedef {Object} olx.control.DefaultsOptions - * @property {boolean|undefined} attribution Attribution. + * @property {boolean|undefined} attribution Attribution. Default is `true`. * @property {olx.control.AttributionOptions|undefined} attributionOptions * Attribution options. - * @property {boolean|undefined} logo Logo. + * @property {boolean|undefined} logo Logo. Default is `true`. * @property {olx.control.LogoOptions|undefined} logoOptions Logo options. - * @property {boolean|undefined} zoom Zoom. + * @property {boolean|undefined} zoom Zoom. Default is `true`. * @property {olx.control.ZoomOptions|undefined} zoomOptions Zoom options. * @todo stability experimental */ @@ -245,9 +245,10 @@ /** * @typedef {Object} olx.control.ScaleLineOptions * @property {string|undefined} className CSS Class name. Default is `ol-scale-line`. - * @property {number|undefined} minWidth Minimum width in pixels. + * @property {number|undefined} minWidth Minimum width in pixels. Default is `64`. * @property {Element|undefined} target Target. * @property {ol.control.ScaleLineUnits|undefined} units Units. + * Default is `ol.control.ScaleLineUnits.METRIC`. * @todo stability experimental */ @@ -322,20 +323,20 @@ * Interactions for the map. Default is `true` for all options. * @typedef {Object} olx.interaction.DefaultsOptions * @property {boolean|undefined} altShiftDragRotate Whether Alt-Shift-drag - * rotate is desired. + * rotate is desired. Default is `true`. * @property {boolean|undefined} doubleClickZoom Whether double click zoom is - * desired. - * @property {boolean|undefined} dragPan Whether drag-pan is desired. + * desired. Default is `true`. + * @property {boolean|undefined} dragPan Whether drag-pan is desired. Default is `true`. * @property {boolean|undefined} keyboard Whether keyboard interaction is - * desired. + * desired. Default is `true`. * @property {boolean|undefined} mouseWheelZoom Whether mousewheel zoom is - * desired. + * desired. Default is `true`. * @property {boolean|undefined} shiftDragZoom Whether Shift-drag zoom is - * desired. + * desired. Default is `true`. * @property {boolean|undefined} touchPan Whether touch pan is - * desired. - * @property {boolean|undefined} touchRotate Whether touch rotate is desired. - * @property {boolean|undefined} touchZoom Whether touch zoom is desired. + * desired. Default is `true`. + * @property {boolean|undefined} touchRotate Whether touch rotate is desired. Default is `true`. + * @property {boolean|undefined} touchZoom Whether touch zoom is desired. Default is `true`. * @property {number|undefined} zoomDelta Zoom delta. * @property {number|undefined} zoomDuration Zoom duration. * @todo stability experimental @@ -634,14 +635,14 @@ /** * @typedef {Object} olx.source.MapGuideOptions * @property {string|undefined} url The mapagent url. - * @property {number|undefined} metersPerUnit The meters-per-unit value. - * @property {ol.Extent|undefined} extent Extent.. - * @property {boolean|undefined} useOverlay If true, will use - * GETDYNAMICMAPOVERLAYIMAGE. + * @property {number|undefined} metersPerUnit The meters-per-unit value. Default is `1`. + * @property {ol.Extent|undefined} extent Extent. + * @property {boolean|undefined} useOverlay If `true`, will use + * `GETDYNAMICMAPOVERLAYIMAGE`. * @property {ol.proj.ProjectionLike} projection Projection. - * @property {number|undefined} ratio Ratio. 1 means image requests are the size - * of the map viewport, 2 means twice the size of the map viewport, and so - * on. + * @property {number|undefined} ratio Ratio. `1` means image requests are the size + * of the map viewport, `2` means twice the size of the map viewport, and so + * on. Default is `1`. * @property {Array.|undefined} resolutions Resolutions. If specified, * requests will be made for these resolutions only. * @property {Object|undefined} params Additional parameters. @@ -687,9 +688,9 @@ * `1.3.0` by default. `WIDTH`, `HEIGHT`, `BBOX` and `CRS` (`SRS` for WMS * version < 1.3.0) will be set dynamically. * @property {ol.proj.ProjectionLike} projection Projection. - * @property {number|undefined} ratio Ratio. 1 means image requests are the size - * of the map viewport, 2 means twice the size of the map viewport, and so - * on. + * @property {number|undefined} ratio Ratio. `1` means image requests are the size + * of the map viewport, `2` means twice the size of the map viewport, and so + * on. Default is `1.5`. * @property {Array.|undefined} resolutions Resolutions. If specified, * requests will be made for these resolutions only. * @property {string|undefined} url WMS service URL.