Skip to content

Commit

Permalink
JsDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
rldhont committed Jun 25, 2024
1 parent aa75c17 commit 9bf44d3
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions assets/src/modules/state/MapLayer.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,63 +80,63 @@ export class MapItemState extends EventDispatcher {
layerItemState.addListener(this.dispatch.bind(this), 'layer.filter.token.changed');
}
}

/**
* Config layers
* Map item name
* @type {string}
*/
get name() {
return this._layerItemState.name;
}

/**
* Config layers
* Map item type
* @type {string}
*/
get type() {
return this._type;
}

/**
* the layer tree item level
* the layer item level
* @type {number}
*/
get level() {
return this._layerItemState.level;
}

/**
* WMS layer name
* WMS item name
* @type {?string}
*/
get wmsName() {
return this._layerItemState.wmsName;
}

/**
* WMS layer title
* WMS item title
* @type {string}
*/
get wmsTitle() {
return this._layerItemState.wmsTitle;
}

/**
* WMS layer Geographic Bounding Box
* WMS item Geographic Bounding Box
* @type {?LayerGeographicBoundingBoxConfig}
*/
get wmsGeographicBoundingBox() {
return this._layerItemState.wmsGeographicBoundingBox;
}

/**
* WMS layer Bounding Boxes
* WMS item Bounding Boxes
* @type {LayerBoundingBoxConfig[]}
*/
get wmsBoundingBoxes() {
return this._layerItemState.wmsBoundingBoxes;
}


/**
* WMS Minimum scale denominator
* If the minimum scale denominator is not defined: -1 is returned
Expand All @@ -150,7 +150,7 @@ export class MapItemState extends EventDispatcher {
}

/**
* WMS layer maximum scale denominator
* WMS Maximum scale denominator
* If the maximum scale denominator is not defined: -1 is returned
* If the WMS layer is a group, the maximum scale denominator is the largest of the layers in the group
* @type {number}
Expand All @@ -160,23 +160,23 @@ export class MapItemState extends EventDispatcher {
}

/**
* Layer tree item is checked
* Map item is checked
* @type {boolean}
*/
get checked() {
return this._layerItemState.checked;
}

/**
* Set layer tree item is checked
* Set map item is checked
* @type {boolean}
*/
set checked(val) {
this._layerItemState.checked = val;
}

/**
* Layer tree item is visible
* Map item is visible
* It depends on the parent visibility
* @type {boolean}
*/
Expand All @@ -185,15 +185,15 @@ export class MapItemState extends EventDispatcher {
}

/**
* Layer tree item opacity
* Map item opacity
* @type {number}
*/
get opacity() {
return this._layerItemState.opacity;
}

/**
* Set layer tree item opacity
* Set map item opacity
* @type {number}
*/
set opacity(val) {
Expand All @@ -210,7 +210,7 @@ export class MapItemState extends EventDispatcher {

/**
* Lizmap layer item state
* @type {?LayerConfig}
* @type {?LayerItemState}
*/
get itemState() {
return this._layerItemState;
Expand Down Expand Up @@ -526,19 +526,19 @@ export class MapLayerState extends MapItemState {
}

/**
* set if the map layer is loaded in a single ImageWMS layer or not
* @param {boolean} val
* vector layer is loaded in a single layer ImageLayer or not
* @type {boolean}
*/
set singleWMSLayer(val){
this._singleWMSLayer = val;
get singleWMSLayer(){
return this._singleWMSLayer;
}

/**
* vector layer is loaded in a single layer ImageLayer or not
* set if the map layer is loaded in a single ImageWMS layer or not
* @type {boolean}
*/
get singleWMSLayer(){
return this._singleWMSLayer;
set singleWMSLayer(val){
this._singleWMSLayer = val;
}

/**
Expand Down

0 comments on commit 9bf44d3

Please sign in to comment.