Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@2gis/deck2gis-layer

Package Overview
Dependencies
Maintainers
8
Versions
42
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@2gis/deck2gis-layer - npm Package Compare versions

Comparing version 1.1.4 to 1.1.5

2

dist/docs.json

@@ -1,1 +0,1 @@

{"typescript":{"Deck2gisLayer":{"documentation":{"contents":["<p>A class that provides rendering any deck.gl layer inside the MapGl canvas / WebGL context.</p>\n"],"contentsRaw":"A class that provides rendering any deck.gl layer inside the MapGl canvas / WebGL context.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"class","name":"Deck2gisLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L46","implements":["DeckCustomLayer"],"methods":[{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":true},"kind":"method","name":"initDeck2gisProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L56","signatures":[{"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"initDeck2gisProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L56","parameters":[{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"map","type":"Map"},{"flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"deckProps","type":"CustomRenderProps"}],"returnType":"DeckProps","type":"(map: Map, deckProps?: CustomRenderProps) => DeckProps"}]},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"setProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L150","signatures":[{"documentation":{"contents":["<p>Sets layer properties and updates the layer.</p>\n"],"contentsRaw":"Sets layer properties and updates the layer.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"setProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L150","parameters":[{"documentation":{"contents":["<p>deck.gl layer properties.</p>\n"],"contentsRaw":"deck.gl layer properties.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"props","type":"Partial<LayerProps<LayerT>>"}],"returnType":"void","type":"(props: Partial<LayerProps<LayerT>>) => void"}]}],"properties":[{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"antialiasing","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L54","type":"boolean"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"deck","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L51","type":"Deck | null"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"gl","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L53","type":"WebGLRenderingContext | WebGL2RenderingContext"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"id","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L47","type":"string"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"map","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L50","type":"Map | null"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"props","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L52","type":"LayerProps<LayerT>"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"renderingMode","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L49","type":"\"2d\" | \"3d\""},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"type","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L48","type":"\"custom\""}],"accessors":[],"constructorType":{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const deckLayer = new mapgl.Deck2gisLayer(map, {\n id: &#39;deckLayer&#39;,\n deck,\n type: HexagonLayer,\n data,\n getPosition: (d) =&gt; [d.point.lon, d.point.lat]\n});\n\nmap.addLayer(deckLayer);</code></pre>\n"],"contentsRaw":"Example:\n```js\nconst deckLayer = new mapgl.Deck2gisLayer(map, {\n id: 'deckLayer',\n deck,\n type: HexagonLayer,\n data,\n getPosition: (d) => [d.point.lon, d.point.lat]\n});\n\nmap.addLayer(deckLayer);\n```","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"constructor","name":"constructor","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L61","signatures":[{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const deckLayer = new mapgl.Deck2gisLayer(map, {\n id: &#39;deckLayer&#39;,\n deck,\n type: HexagonLayer,\n data,\n getPosition: (d) =&gt; [d.point.lon, d.point.lat]\n});\n\nmap.addLayer(deckLayer);</code></pre>\n"],"contentsRaw":"Example:\n```js\nconst deckLayer = new mapgl.Deck2gisLayer(map, {\n id: 'deckLayer',\n deck,\n type: HexagonLayer,\n data,\n getPosition: (d) => [d.point.lon, d.point.lat]\n});\n\nmap.addLayer(deckLayer);\n```","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"new Deck2gisLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L61","parameters":[{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"props","type":"LayerProps<LayerT>"}],"returnType":"Deck2gisLayer","type":"(props: LayerProps<LayerT>) => Deck2gisLayer"}]}},"initDeck2gisProps":{"fileName":"src/utils.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"method","name":"initDeck2gisProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/utils.ts#L205","signatures":[{"documentation":{"contents":["<p>Initializes deck.gl properties for working with the MapGL map.</p>\n"],"contentsRaw":"Initializes deck.gl properties for working with the MapGL map.","metadata":{}},"fileName":"src/utils.ts","kind":"signature","name":"initDeck2gisProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/utils.ts#L205","parameters":[{"documentation":{"contents":["<p>The map instance.</p>\n"],"contentsRaw":"The map instance.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"map","type":"Map"},{"documentation":{"contents":["<p>CustomRenderProps initialization options.</p>\n"],"contentsRaw":"CustomRenderProps initialization options.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"deckProps","type":"CustomRenderProps"}],"returnType":"DeckProps","type":"(map: Map, deckProps?: CustomRenderProps) => DeckProps"}]},"DeckCustomLayer":{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DeckCustomLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/types.ts#L6","methods":[],"properties":[{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"id","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/types.ts#L8","type":"string"},{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"props","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/types.ts#L10","type":"any"},{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"render","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/types.ts#L9","type":"(gl: WebGLRenderingContext) => void"},{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"type","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/types.ts#L7","type":"\"custom\""}]},"DeckInternalLayerProps":{"documentation":{"contents":["<p>Deck2gisLayer layer props</p>\n"],"contentsRaw":"Deck2gisLayer layer props","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DeckInternalLayerProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L29","methods":[],"properties":[{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"antialiasing","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L34","type":"undefined | false | true"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"deck","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L32","type":"Deck"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"id","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L30","type":"string"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"renderingMode","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L31","type":"\"2d\" | \"3d\""},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"type","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L33","type":"DeckBaseLayer"}]},"CustomRenderProps":{"documentation":{"contents":["<p>CustomRenderProps is type extends from DeckProps:\n<a href=\"https://deck.gl/docs/api-reference/core/deck#properties\">https://deck.gl/docs/api-reference/core/deck#properties</a></p>\n"],"contentsRaw":"CustomRenderProps is type extends from DeckProps:\nhttps://deck.gl/docs/api-reference/core/deck#properties","metadata":{}},"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"type alias","name":"CustomRenderProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/types.ts#L50","type":"Partial<DeckProps> & CustomRenderInternalProps"},"DeckBaseLayer":{"documentation":{"contents":["<p>A class that extends deck.gl&#39;s base Layer class.</p>\n"],"contentsRaw":"A class that extends deck.gl's base Layer class.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"type alias","name":"DeckBaseLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L24","type":"any"},"LayerProps":{"documentation":{"contents":["<p>LayerProps is type extends from Layer:\n<a href=\"https://deck.gl/docs/api-reference/core/layer\">https://deck.gl/docs/api-reference/core/layer</a></p>\n"],"contentsRaw":"LayerProps is type extends from Layer:\nhttps://deck.gl/docs/api-reference/core/layer","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"type alias","name":"LayerProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/330204c/src/deckgl2gisLayer.ts#L41","type":"DeckInternalLayerProps & Partial<LayerT[\"props\"]>"}}}
{"typescript":{"Deck2gisLayer":{"documentation":{"contents":["<p>A class that provides rendering any deck.gl layer inside the MapGl canvas / WebGL context.</p>\n"],"contentsRaw":"A class that provides rendering any deck.gl layer inside the MapGl canvas / WebGL context.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"class","name":"Deck2gisLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L46","implements":["DeckCustomLayer"],"methods":[{"documentation":{"contents":["<p>Initializes deck.gl properties for working with the MapGL map.</p>\n"],"contentsRaw":"Initializes deck.gl properties for working with the MapGL map.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":true},"kind":"method","name":"initDeck2gisProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L61","signatures":[{"documentation":{"contents":["<p>Initializes deck.gl properties for working with the MapGL map.</p>\n"],"contentsRaw":"Initializes deck.gl properties for working with the MapGL map.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"initDeck2gisProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L61","parameters":[{"documentation":{"contents":["<p>The map instance.</p>\n"],"contentsRaw":"The map instance.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"map","type":"Map"},{"documentation":{"contents":["<p>CustomRenderProps initialization options.</p>\n"],"contentsRaw":"CustomRenderProps initialization options.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"deckProps","type":"CustomRenderProps"}],"returnType":"DeckProps","type":"(map: Map, deckProps?: CustomRenderProps) => DeckProps"}]},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"setProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L155","signatures":[{"documentation":{"contents":["<p>Sets layer properties and updates the layer.</p>\n"],"contentsRaw":"Sets layer properties and updates the layer.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"setProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L155","parameters":[{"documentation":{"contents":["<p>deck.gl layer properties.</p>\n"],"contentsRaw":"deck.gl layer properties.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"props","type":"Partial<LayerProps<LayerT>>"}],"returnType":"void","type":"(props: Partial<LayerProps<LayerT>>) => void"}]}],"properties":[{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"antialiasing","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L54","type":"boolean"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"deck","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L51","type":"Deck | null"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"gl","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L53","type":"WebGLRenderingContext | WebGL2RenderingContext"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"id","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L47","type":"string"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"map","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L50","type":"Map | null"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"props","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L52","type":"LayerProps<LayerT>"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"renderingMode","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L49","type":"\"2d\" | \"3d\""},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"type","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L48","type":"\"custom\""}],"accessors":[],"constructorType":{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const deckLayer = new mapgl.Deck2gisLayer(map, {\n id: &#39;deckLayer&#39;,\n deck,\n type: HexagonLayer,\n data,\n getPosition: (d) =&gt; [d.point.lon, d.point.lat]\n});\n\nmap.addLayer(deckLayer);</code></pre>\n"],"contentsRaw":"Example:\n```js\nconst deckLayer = new mapgl.Deck2gisLayer(map, {\n id: 'deckLayer',\n deck,\n type: HexagonLayer,\n data,\n getPosition: (d) => [d.point.lon, d.point.lat]\n});\n\nmap.addLayer(deckLayer);\n```","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"constructor","name":"constructor","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L66","signatures":[{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const deckLayer = new mapgl.Deck2gisLayer(map, {\n id: &#39;deckLayer&#39;,\n deck,\n type: HexagonLayer,\n data,\n getPosition: (d) =&gt; [d.point.lon, d.point.lat]\n});\n\nmap.addLayer(deckLayer);</code></pre>\n"],"contentsRaw":"Example:\n```js\nconst deckLayer = new mapgl.Deck2gisLayer(map, {\n id: 'deckLayer',\n deck,\n type: HexagonLayer,\n data,\n getPosition: (d) => [d.point.lon, d.point.lat]\n});\n\nmap.addLayer(deckLayer);\n```","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"new Deck2gisLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L66","parameters":[{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"props","type":"LayerProps<LayerT>"}],"returnType":"Deck2gisLayer","type":"(props: LayerProps<LayerT>) => Deck2gisLayer"}]}},"initDeck2gisProps":{"fileName":"src/utils.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"method","name":"initDeck2gisProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/utils.ts#L205","signatures":[{"documentation":{"contents":["<p>Initializes deck.gl properties for working with the MapGL map.</p>\n"],"contentsRaw":"Initializes deck.gl properties for working with the MapGL map.","metadata":{}},"fileName":"src/utils.ts","kind":"signature","name":"initDeck2gisProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/utils.ts#L205","parameters":[{"documentation":{"contents":["<p>The map instance.</p>\n"],"contentsRaw":"The map instance.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"map","type":"Map"},{"documentation":{"contents":["<p>CustomRenderProps initialization options.</p>\n"],"contentsRaw":"CustomRenderProps initialization options.","metadata":{}},"flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"deckProps","type":"CustomRenderProps"}],"returnType":"DeckProps","type":"(map: Map, deckProps?: CustomRenderProps) => DeckProps"}]},"DeckCustomLayer":{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"DeckCustomLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/types.ts#L6","methods":[],"properties":[{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"id","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/types.ts#L8","type":"string"},{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"props","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/types.ts#L10","type":"any"},{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"render","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/types.ts#L9","type":"(gl: WebGLRenderingContext) => void"},{"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"type","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/types.ts#L7","type":"\"custom\""}]},"Deck2gisLayerProps":{"documentation":{"contents":["<p>Deck2gisLayer required layer props.</p>\n"],"contentsRaw":"Deck2gisLayer required layer props.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"interface","name":"Deck2gisLayerProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L29","methods":[],"properties":[{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"antialiasing","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L34","type":"undefined | false | true"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"deck","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L32","type":"Deck"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"id","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L30","type":"string"},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":true,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"renderingMode","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L31","type":"\"2d\" | \"3d\""},{"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"property","name":"type","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L33","type":"DeckLayer"}]},"CustomRenderProps":{"documentation":{"contents":["<p>CustomRenderProps is type extends from DeckProps:\n<a href=\"https://deck.gl/docs/api-reference/core/deck#properties\">https://deck.gl/docs/api-reference/core/deck#properties</a></p>\n"],"contentsRaw":"CustomRenderProps is type extends from DeckProps:\nhttps://deck.gl/docs/api-reference/core/deck#properties","metadata":{}},"fileName":"src/types.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"type alias","name":"CustomRenderProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/types.ts#L50","type":"Partial<DeckProps> & CustomRenderInternalProps"},"DeckLayer":{"documentation":{"contents":["<p>The any Layer class from deck.gl.</p>\n"],"contentsRaw":"The any Layer class from deck.gl.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"type alias","name":"DeckLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L24","type":"any"},"LayerProps":{"documentation":{"contents":["<p>LayerProps is type extends from Layer:\n<a href=\"https://deck.gl/docs/api-reference/core/layer\">https://deck.gl/docs/api-reference/core/layer</a></p>\n"],"contentsRaw":"LayerProps is type extends from Layer:\nhttps://deck.gl/docs/api-reference/core/layer","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"type alias","name":"LayerProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/d917686/src/deckgl2gisLayer.ts#L41","type":"Deck2gisLayerProps & Partial<LayerT[\"props\"]>"}}}

17

dist/types/deckgl2gisLayer.d.ts

@@ -5,13 +5,13 @@ import type { Deck, Layer } from '@deck.gl/core/typed';

/**
* A class that extends deck.gl's base Layer class.
* The any Layer class from deck.gl.
*/
export type DeckBaseLayer = any;
export type DeckLayer = any;
/**
* Deck2gisLayer layer props
* Deck2gisLayer required layer props.
*/
export interface DeckInternalLayerProps {
export interface Deck2gisLayerProps {
id: string;
renderingMode?: '2d' | '3d';
deck: Deck;
type: DeckBaseLayer;
type: DeckLayer;
antialiasing?: boolean;

@@ -23,3 +23,3 @@ }

*/
export type LayerProps<LayerT extends Layer> = DeckInternalLayerProps & Partial<LayerT['props']>;
export type LayerProps<LayerT extends Layer> = Deck2gisLayerProps & Partial<LayerT['props']>;
/**

@@ -37,2 +37,7 @@ * A class that provides rendering any deck.gl layer inside the MapGl canvas / WebGL context.

antialiasing: boolean;
/**
* Initializes deck.gl properties for working with the MapGL map.
* @param map The map instance.
* @param deckProps CustomRenderProps initialization options.
*/
static initDeck2gisProps: (map: Map, deckProps?: CustomRenderProps) => import("@deck.gl/core/typed").DeckProps;

@@ -39,0 +44,0 @@ private frameBuffer?;

2

package.json
{
"name": "@2gis/deck2gis-layer",
"version": "1.1.4",
"version": "1.1.5",
"description": "",

@@ -5,0 +5,0 @@ "main": "dist/deck2gislayer.js",

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc