Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

option to further customize panes #1272

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

option to further customize panes #1272

wants to merge 5 commits into from

Conversation

TurtIeSocks
Copy link
Contributor

  • Adds circlePane, polylinePane, and polygonPane to globalOptions.panes
  • Maintains backwards compatibility with defaults all falling back to overlayPane

@TurtIeSocks
option to further customize panes
9a5dd1b 
- Adds `circlePane`, `polylinePane`, and `polygonPane` to `globalOptions.panes`
- Maintains backwards compatibility with defaults all falling back to `overlayPane`
@TurtIeSocks
backwards compatibility fix
d1ccb98
Falke-Design
Falke-Design requested changes Dec 30, 2022
View reviewed changes
Copy link
Collaborator

@Falke-Design Falke-Design left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding this, can you please add a option for every shape. CircleMarker, Text, Rectangle

Falke-Design
Falke-Design requested changes Feb 19, 2023
View reviewed changes
src/js/L.PM.Map.js
Comment on lines +143 to +151
if (o.panes && o.panes.layerPane && !o.panes.circleMarkerPane) {
options.panes.polygonPane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.rectanglePane) {
options.panes.polylinePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.textPane) {
options.panes.circlePane = o.panes.markerPane;
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (o.panes && o.panes.layerPane && !o.panes.circleMarkerPane) {
options.panes.polygonPane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.rectanglePane) {
options.panes.polylinePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.textPane) {
options.panes.circlePane = o.panes.markerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.circleMarkerPane) {
options.panes.circleMarkerPane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.rectanglePane) {
options.panes.rectanglePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.textPane) {
options.panes.textPane = o.panes.markerPane;
}

src/js/L.PM.Map.js
Comment on lines +134 to +151
if (o.panes && o.panes.layerPane && !o.panes.polygonPane) {
options.panes.polygonPane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.polylinePane) {
options.panes.polylinePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.circlePane) {
options.panes.circlePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.circleMarkerPane) {
options.panes.polygonPane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.rectanglePane) {
options.panes.polylinePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.textPane) {
options.panes.circlePane = o.panes.markerPane;
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (o.panes && o.panes.layerPane && !o.panes.polygonPane) {
options.panes.polygonPane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.polylinePane) {
options.panes.polylinePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.circlePane) {
options.panes.circlePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.circleMarkerPane) {
options.panes.polygonPane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.rectanglePane) {
options.panes.polylinePane = o.panes.layerPane;
}
if (o.panes && o.panes.layerPane && !o.panes.textPane) {
options.panes.circlePane = o.panes.markerPane;
}
if (o.panes) {
if(o.panes.layerPane){
if(!o.panes.polygonPane) {
options.panes.polygonPane = o.panes.layerPane;
}
if (!o.panes.polylinePane) {
options.panes.polylinePane = o.panes.layerPane;
}
if (!o.panes.circlePane) {
options.panes.circlePane = o.panes.layerPane;
}
if (!o.panes.circleMarkerPane) {
options.panes.circleMarkerPane = o.panes.layerPane;
}
if (!o.panes.rectanglePane) {
options.panes.rectanglePane= o.panes.layerPane;
}
}
if (o.panes.markerPane && !o.panes.textPane) {
options.panes.textPane = o.panes.markerPane;
}
}

README.md
| :------------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| snappingOrder | `Array` | Prioritize the order of snapping. Default: `['Marker','CircleMarker','Circle','Line','Polygon','Rectangle']`. |
| layerGroup | `map` | add the created layers to a layergroup instead to the map. |
| panes | `Object` | Defines in which [panes](https://leafletjs.com/reference.html#map-pane) the layers and helper vertices are created. Default: `{ vertexPane: 'markerPane', layerPane: 'overlayPane', markerPane: 'markerPane', circlePane: 'overlayPane', polylinePane: 'overlayPane', polygonPane: 'overlayPane', circleMarkerPane: 'overlayPane', rectanglePane: 'overlayPane', textPane: 'markerPane' }`. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let us remove layerPane from the docs because it is now deprecated, but keep the logic in L.PM.Edit with a deprecated comment

leaflet-geoman.d.ts
Comment on lines +773 to +774
/** Defines in which panes the layers and helper vertices are created. Default: { vertexPane: 'markerPane', layerPane: 'overlayPane', markerPane: 'markerPane', circlePane: 'overlayPane', polygonPane: 'overlayPane', polylinePane: 'overlayPane' } */
panes?: { vertexPane?: PANE; layerPane?: PANE; markerPane?: PANE, circlePane?: PANE, polygonPane?: PANE, polylinePane?: PANE, circleMarkerPane?: PANE, rectanglePane?: PANE, textPane?: PANE };
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove layerPane

src/js/Draw/L.PM.Draw.js
Comment on lines +222 to +257
} else if (type === 'polygonPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.polygonPane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'circlePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.circlePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'circleMarkerPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.circleMarkerPane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'polylinePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.polylinePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'rectanglePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.rectanglePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'textPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.textPane ||
this._map.pm.globalOptions.panes.markerPane)) ||
'markerPane';
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let us simplify this a little bit:

Suggested change
} else if (type === 'polygonPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.polygonPane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'circlePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.circlePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'circleMarkerPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.circleMarkerPane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'polylinePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.polylinePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'rectanglePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.rectanglePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'textPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.textPane ||
this._map.pm.globalOptions.panes.markerPane)) ||
'markerPane';
_setPane(layer, type) {
const panes = this._map.pm.globalOptions.panes || {};
if (type === 'layerPane') {
layer.options.pane = panes.layerPane || 'overlayPane';
} else if (type === 'vertexPane') {
layer.options.pane = panes.vertexPane || 'markerPane';
} else if (type === 'markerPane') {
layer.options.pane = panes.markerPane || 'markerPane';
}
},

src/js/Edit/L.PM.Edit.js
Comment on lines +60 to +95
} else if (type === 'polygonPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.polygonPane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'circlePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.circlePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'circleMarkerPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.circleMarkerPane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'polylinePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.polylinePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'rectanglePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.rectanglePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'textPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.textPane ||
this._map.pm.globalOptions.panes.markerPane)) ||
'markerPane';
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
} else if (type === 'polygonPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.polygonPane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'circlePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.circlePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'circleMarkerPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.circleMarkerPane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'polylinePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.polylinePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'rectanglePane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.rectanglePane ||
this._map.pm.globalOptions.panes.layerPane)) ||
'overlayPane';
} else if (type === 'textPane') {
layer.options.pane =
(this._map.pm.globalOptions.panes &&
(this._map.pm.globalOptions.panes.textPane ||
this._map.pm.globalOptions.panes.markerPane)) ||
'markerPane';
_setPane(layer, type) {
const panes = this._map.pm.globalOptions.panes || {};
if (type === 'layerPane') {
layer.options.pane = panes.layerPane || 'overlayPane';
} else if (type === 'vertexPane') {
layer.options.pane = panes.vertexPane || 'markerPane';
} else if (type === 'markerPane') {
layer.options.pane = panes.markerPane || 'markerPane';
}
},

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Falke-Design Falke-Design Falke-Design requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@TurtIeSocks @Falke-Design