dash-openlayers 0.0.1__py3-none-any.whl

dash_openlayers/DrawInteraction.py

@@ -0,0 +1,89 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.types import NumberType  # noqa: F401
+except ImportError:
+    # Backwards compatibility for dash<=4.1.0
+    if typing.TYPE_CHECKING:
+        raise
+    NumberType = typing.Union[  # noqa: F401
+        typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+    ]
+
+ComponentSingleType = typing.Union[str, int, float, Component, None]
+ComponentType = typing.Union[
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
+]
+
+
+class DrawInteraction(Component):
+    """A DrawInteraction component.
+Draw and validate OpenLayers features, then publish their serialized geometry to Dash.
+
+Keyword arguments:
+
+- id (string; optional):
+    The ID used to identify this component in Dash callbacks.
+
+- geometryType (a value equal to: 'Point', 'LineString', 'Polygon', 'Circle'; default 'Polygon'):
+    Geometry type drawn by this interaction.
+
+- drawnGeoJSON (dict; optional):
+    Read-only GeoJSON Feature emitted only when geometry validation
+    succeeds.
+
+- drawnWKT (string; optional):
+    Read-only WKT geometry emitted only when geometry validation
+    succeeds.
+
+- drawnTopoJSON (dict; optional):
+    Read-only TopoJSON topology emitted only when geometry validation
+    succeeds.
+
+- geometryValidation (dict; optional):
+    Read-only validity, topology errors, and repair suggestions from
+    the last draw.
+
+- snapToVertex (boolean; default True):
+    Whether drawing snaps to existing vector vertices.
+
+- snapToEdge (boolean; default True):
+    Whether drawing snaps to existing vector edges.
+
+- snapTolerance (number; default 10):
+    Maximum snap distance in screen pixels."""
+    _children_props: typing.List[str] = []
+    _base_nodes = ['children']
+    _namespace = 'dash_openlayers'
+    _type = 'DrawInteraction'
+
+
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        geometryType: typing.Optional[Literal["Point", "LineString", "Polygon", "Circle"]] = None,
+        drawnGeoJSON: typing.Optional[dict] = None,
+        drawnWKT: typing.Optional[str] = None,
+        drawnTopoJSON: typing.Optional[dict] = None,
+        geometryValidation: typing.Optional[dict] = None,
+        snapToVertex: typing.Optional[bool] = None,
+        snapToEdge: typing.Optional[bool] = None,
+        snapTolerance: typing.Optional[NumberType] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'geometryType', 'drawnGeoJSON', 'drawnWKT', 'drawnTopoJSON', 'geometryValidation', 'snapToVertex', 'snapToEdge', 'snapTolerance']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'geometryType', 'drawnGeoJSON', 'drawnWKT', 'drawnTopoJSON', 'geometryValidation', 'snapToVertex', 'snapToEdge', 'snapTolerance']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(DrawInteraction, self).__init__(**args)
+
+setattr(DrawInteraction, "__init__", _explicitize_args(DrawInteraction.__init__))

dash_openlayers/ImageWMS.py

@@ -0,0 +1,66 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.types import NumberType  # noqa: F401
+except ImportError:
+    # Backwards compatibility for dash<=4.1.0
+    if typing.TYPE_CHECKING:
+        raise
+    NumberType = typing.Union[  # noqa: F401
+        typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+    ]
+
+ComponentSingleType = typing.Union[str, int, float, Component, None]
+ComponentType = typing.Union[
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
+]
+
+
+class ImageWMS(Component):
+    """An ImageWMS component.
+Render a single-image OGC Web Map Service layer.
+
+Keyword arguments:
+
+- id (string; optional):
+    Component ID used to identify this layer in the Dash layout.
+
+- url (string; optional):
+    OGC WMS endpoint URL.
+
+- params (dict; optional):
+    WMS request parameters, including LAYERS; changes refresh the
+    source.
+
+- serverType (a value equal to: 'carmentaserver', 'geoserver', 'mapserver', 'qgis'; optional):
+    WMS server type used for vendor-specific HiDPI request parameters."""
+    _children_props: typing.List[str] = []
+    _base_nodes = ['children']
+    _namespace = 'dash_openlayers'
+    _type = 'ImageWMS'
+
+
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        url: typing.Optional[str] = None,
+        params: typing.Optional[dict] = None,
+        serverType: typing.Optional[Literal["carmentaserver", "geoserver", "mapserver", "qgis"]] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'url', 'params', 'serverType']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'url', 'params', 'serverType']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(ImageWMS, self).__init__(**args)
+
+setattr(ImageWMS, "__init__", _explicitize_args(ImageWMS.__init__))

dash_openlayers/LayerControl.py

@@ -0,0 +1,61 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.types import NumberType  # noqa: F401
+except ImportError:
+    # Backwards compatibility for dash<=4.1.0
+    if typing.TYPE_CHECKING:
+        raise
+    NumberType = typing.Union[  # noqa: F401
+        typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+    ]
+
+ComponentSingleType = typing.Union[str, int, float, Component, None]
+ComponentType = typing.Union[
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
+]
+
+
+class LayerControl(Component):
+    """A LayerControl component.
+Layer visibility, opacity, and stacking-order controls for map layers.
+
+Keyword arguments:
+
+- id (string; optional):
+    The ID used to identify this component in Dash callbacks.
+
+- position (a value equal to: 'top-left', 'top-right', 'bottom-left', 'bottom-right'; default 'top-right'):
+    Corner of the map where the control is displayed.
+
+- title (string; default 'Layers'):
+    Heading displayed above the layer controls."""
+    _children_props: typing.List[str] = []
+    _base_nodes = ['children']
+    _namespace = 'dash_openlayers'
+    _type = 'LayerControl'
+
+
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        position: typing.Optional[Literal["top-left", "top-right", "bottom-left", "bottom-right"]] = None,
+        title: typing.Optional[str] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'position', 'title']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'position', 'title']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(LayerControl, self).__init__(**args)
+
+setattr(LayerControl, "__init__", _explicitize_args(LayerControl.__init__))

dash_openlayers/Map.py

@@ -0,0 +1,111 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.types import NumberType  # noqa: F401
+except ImportError:
+    # Backwards compatibility for dash<=4.1.0
+    if typing.TYPE_CHECKING:
+        raise
+    NumberType = typing.Union[  # noqa: F401
+        typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+    ]
+
+ComponentSingleType = typing.Union[str, int, float, Component, None]
+ComponentType = typing.Union[
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
+]
+
+
+class Map(Component):
+    """A Map component.
+Create an OpenLayers map and synchronize its view and click events with Dash.
+
+Keyword arguments:
+
+- id (string; optional):
+    The ID used to identify this component in Dash callbacks.
+
+- children (a list of or a singular dash component, string or number; optional):
+    OpenLayers layer and interaction components rendered inside this
+    map.
+
+- center (list of numbers; default [0, 0]):
+    Map view center as [x, y] in projection units; bidirectional with
+    the rendered view.
+
+- zoom (number; default 2):
+    Map zoom level; bidirectional with the rendered view.
+
+- projection (string; default 'EPSG:3857'):
+    EPSG code used for the map view.
+
+- proj4Defs (list of dicts; optional):
+    Custom proj4 definitions registered before the map view is
+    created.
+
+    `proj4Defs` is a list of dicts with keys:
+
+    - code (string; required)
+
+    - def (string; required)
+
+- clickData (dict; optional):
+    Read-only click position with raw projected coordinates and
+    [latitude, longitude].
+
+- undo (number; default 0):
+    Increment to undo the latest Draw or Modify operation.
+
+- redo (number; default 0):
+    Increment to redo the latest undone operation.
+
+- canUndo (boolean; optional):
+    Read-only; whether an operation is available to undo.
+
+- canRedo (boolean; optional):
+    Read-only; whether an operation is available to redo."""
+    _children_props: typing.List[str] = []
+    _base_nodes = ['children']
+    _namespace = 'dash_openlayers'
+    _type = 'Map'
+    Proj4Defs = TypedDict(
+        "Proj4Defs",
+            {
+            "code": str,
+            "def": str
+        }
+    )
+
+
+    def __init__(
+        self,
+        children: typing.Optional[ComponentType] = None,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        center: typing.Optional[typing.Sequence[NumberType]] = None,
+        zoom: typing.Optional[NumberType] = None,
+        projection: typing.Optional[str] = None,
+        proj4Defs: typing.Optional[typing.Sequence["Proj4Defs"]] = None,
+        style: typing.Optional[typing.Any] = None,
+        clickData: typing.Optional[dict] = None,
+        undo: typing.Optional[NumberType] = None,
+        redo: typing.Optional[NumberType] = None,
+        canUndo: typing.Optional[bool] = None,
+        canRedo: typing.Optional[bool] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'children', 'center', 'zoom', 'projection', 'proj4Defs', 'style', 'clickData', 'undo', 'redo', 'canUndo', 'canRedo']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'children', 'center', 'zoom', 'projection', 'proj4Defs', 'style', 'clickData', 'undo', 'redo', 'canUndo', 'canRedo']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args if k != 'children'}
+
+        super(Map, self).__init__(children=children, **args)
+
+setattr(Map, "__init__", _explicitize_args(Map.__init__))

dash_openlayers/ModifyInteraction.py

@@ -0,0 +1,93 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.types import NumberType  # noqa: F401
+except ImportError:
+    # Backwards compatibility for dash<=4.1.0
+    if typing.TYPE_CHECKING:
+        raise
+    NumberType = typing.Union[  # noqa: F401
+        typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+    ]
+
+ComponentSingleType = typing.Union[str, int, float, Component, None]
+ComponentType = typing.Union[
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
+]
+
+
+class ModifyInteraction(Component):
+    """A ModifyInteraction component.
+Allow editing vertices in a VectorLayer and report the updated features.
+
+Keyword arguments:
+
+- id (string; optional):
+    The ID used to identify this component in Dash callbacks.
+
+- layerId (string; optional):
+    Dash ID of the VectorLayer to modify; defaults to the first vector
+    layer on the map.
+
+- snapToVertex (boolean; default True):
+    Whether editing snaps to vector vertices.
+
+- snapToEdge (boolean; default True):
+    Whether editing snaps to vector edges.
+
+- snapTolerance (number; default 10):
+    Maximum snap distance in screen pixels.
+
+- preserveTopology (boolean; default True):
+    Revert polygon edits that introduce invalid topology.
+
+- modifiedGeoJSON (dict; optional):
+    Read-only: GeoJSON FeatureCollection of the target layer after a
+    modify operation.
+
+- modifiedWKT (string; optional):
+    Read-only: WKT geometry collection of the target layer after
+    modification.
+
+- modifiedTopoJSON (dict; optional):
+    Read-only: TopoJSON topology of the target layer after
+    modification.
+
+- geometryValidation (dict; optional):
+    Read-only: topology validation result from the last modification."""
+    _children_props: typing.List[str] = []
+    _base_nodes = ['children']
+    _namespace = 'dash_openlayers'
+    _type = 'ModifyInteraction'
+
+
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        layerId: typing.Optional[str] = None,
+        snapToVertex: typing.Optional[bool] = None,
+        snapToEdge: typing.Optional[bool] = None,
+        snapTolerance: typing.Optional[NumberType] = None,
+        preserveTopology: typing.Optional[bool] = None,
+        modifiedGeoJSON: typing.Optional[dict] = None,
+        modifiedWKT: typing.Optional[str] = None,
+        modifiedTopoJSON: typing.Optional[dict] = None,
+        geometryValidation: typing.Optional[dict] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'layerId', 'snapToVertex', 'snapToEdge', 'snapTolerance', 'preserveTopology', 'modifiedGeoJSON', 'modifiedWKT', 'modifiedTopoJSON', 'geometryValidation']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'layerId', 'snapToVertex', 'snapToEdge', 'snapTolerance', 'preserveTopology', 'modifiedGeoJSON', 'modifiedWKT', 'modifiedTopoJSON', 'geometryValidation']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(ModifyInteraction, self).__init__(**args)
+
+setattr(ModifyInteraction, "__init__", _explicitize_args(ModifyInteraction.__init__))

dash_openlayers/SelectInteraction.py

@@ -0,0 +1,63 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.types import NumberType  # noqa: F401
+except ImportError:
+    # Backwards compatibility for dash<=4.1.0
+    if typing.TYPE_CHECKING:
+        raise
+    NumberType = typing.Union[  # noqa: F401
+        typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+    ]
+
+ComponentSingleType = typing.Union[str, int, float, Component, None]
+ComponentType = typing.Union[
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
+]
+
+
+class SelectInteraction(Component):
+    """A SelectInteraction component.
+Select vector features and report the current selection to Dash.
+
+Keyword arguments:
+
+- id (string; optional):
+    The ID used to identify this component in Dash callbacks.
+
+- layerId (string; optional):
+    Dash ID of the vector layer to select from; omit to allow all
+    selectable layers.
+
+- selectedGeoJSON (dict; optional):
+    Read-only: current selection as a GeoJSON FeatureCollection in
+    EPSG:4326."""
+    _children_props: typing.List[str] = []
+    _base_nodes = ['children']
+    _namespace = 'dash_openlayers'
+    _type = 'SelectInteraction'
+
+
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        layerId: typing.Optional[str] = None,
+        selectedGeoJSON: typing.Optional[dict] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'layerId', 'selectedGeoJSON']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'layerId', 'selectedGeoJSON']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(SelectInteraction, self).__init__(**args)
+
+setattr(SelectInteraction, "__init__", _explicitize_args(SelectInteraction.__init__))

dash_openlayers/TileLayer.py

@@ -0,0 +1,61 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.types import NumberType  # noqa: F401
+except ImportError:
+    # Backwards compatibility for dash<=4.1.0
+    if typing.TYPE_CHECKING:
+        raise
+    NumberType = typing.Union[  # noqa: F401
+        typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+    ]
+
+ComponentSingleType = typing.Union[str, int, float, Component, None]
+ComponentType = typing.Union[
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
+]
+
+
+class TileLayer(Component):
+    """A TileLayer component.
+Render OpenStreetMap or custom XYZ tiles on the map.
+
+Keyword arguments:
+
+- id (string; optional):
+    The ID used to identify this layer in Dash callbacks.
+
+- source (string; optional):
+    Built-in tile source identifier. Currently supports OSM.
+
+- url (string; optional):
+    URL template for a custom XYZ tile source."""
+    _children_props: typing.List[str] = []
+    _base_nodes = ['children']
+    _namespace = 'dash_openlayers'
+    _type = 'TileLayer'
+
+
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        source: typing.Optional[str] = None,
+        url: typing.Optional[str] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'source', 'url']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'source', 'url']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(TileLayer, self).__init__(**args)
+
+setattr(TileLayer, "__init__", _explicitize_args(TileLayer.__init__))

dash_openlayers/TileWMS.py

@@ -0,0 +1,66 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+try:
+    from dash.types import NumberType  # noqa: F401
+except ImportError:
+    # Backwards compatibility for dash<=4.1.0
+    if typing.TYPE_CHECKING:
+        raise
+    NumberType = typing.Union[  # noqa: F401
+        typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+    ]
+
+ComponentSingleType = typing.Union[str, int, float, Component, None]
+ComponentType = typing.Union[
+    ComponentSingleType,
+    typing.Sequence[ComponentSingleType],
+]
+
+
+class TileWMS(Component):
+    """A TileWMS component.
+Render a tiled OGC Web Map Service layer.
+
+Keyword arguments:
+
+- id (string; optional):
+    Component ID used to identify this layer in the Dash layout.
+
+- url (string; optional):
+    OGC WMS endpoint URL.
+
+- params (dict; optional):
+    WMS request parameters, including LAYERS; changes refresh the
+    source.
+
+- serverType (a value equal to: 'carmentaserver', 'geoserver', 'mapserver', 'qgis'; optional):
+    WMS server type used for vendor-specific HiDPI request parameters."""
+    _children_props: typing.List[str] = []
+    _base_nodes = ['children']
+    _namespace = 'dash_openlayers'
+    _type = 'TileWMS'
+
+
+    def __init__(
+        self,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        url: typing.Optional[str] = None,
+        params: typing.Optional[dict] = None,
+        serverType: typing.Optional[Literal["carmentaserver", "geoserver", "mapserver", "qgis"]] = None,
+        **kwargs
+    ):
+        self._prop_names = ['id', 'url', 'params', 'serverType']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['id', 'url', 'params', 'serverType']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args}
+
+        super(TileWMS, self).__init__(**args)
+
+setattr(TileWMS, "__init__", _explicitize_args(TileWMS.__init__))