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

Comparing version 1.1.7 to 1.1.8

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/f5a428d/src/deckgl2gisLayer.ts#L47","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/f5a428d/src/deckgl2gisLayer.ts#L62","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/f5a428d/src/deckgl2gisLayer.ts#L62","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/f5a428d/src/deckgl2gisLayer.ts#L156","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/f5a428d/src/deckgl2gisLayer.ts#L156","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/f5a428d/src/deckgl2gisLayer.ts#L55","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/f5a428d/src/deckgl2gisLayer.ts#L52","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/f5a428d/src/deckgl2gisLayer.ts#L54","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/f5a428d/src/deckgl2gisLayer.ts#L48","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/f5a428d/src/deckgl2gisLayer.ts#L51","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/f5a428d/src/deckgl2gisLayer.ts#L53","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/f5a428d/src/deckgl2gisLayer.ts#L50","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/f5a428d/src/deckgl2gisLayer.ts#L49","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/f5a428d/src/deckgl2gisLayer.ts#L67","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/f5a428d/src/deckgl2gisLayer.ts#L67","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/f5a428d/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/f5a428d/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/f5a428d/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/f5a428d/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/f5a428d/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/f5a428d/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/f5a428d/src/types.ts#L7","type":"\"custom\""}]},"Deck2gisLayerProps":{"documentation":{"contents":["<p>Deck2gisLayer required props.</p>\n"],"contentsRaw":"Deck2gisLayer required 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/f5a428d/src/deckgl2gisLayer.ts#L30","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/f5a428d/src/deckgl2gisLayer.ts#L35","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/f5a428d/src/deckgl2gisLayer.ts#L33","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/f5a428d/src/deckgl2gisLayer.ts#L31","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/f5a428d/src/deckgl2gisLayer.ts#L32","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/f5a428d/src/deckgl2gisLayer.ts#L34","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/f5a428d/src/types.ts#L50","type":"Partial<DeckProps> & CustomRenderInternalProps"},"DeckLayer":{"documentation":{"contents":["<p>Any Layer class from deck.gl.</p>\n"],"contentsRaw":"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/f5a428d/src/deckgl2gisLayer.ts#L25","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/f5a428d/src/deckgl2gisLayer.ts#L42","type":"Deck2gisLayerProps & 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/f6871c9/src/deckgl2gisLayer.ts#L47","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/f6871c9/src/deckgl2gisLayer.ts#L63","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/f6871c9/src/deckgl2gisLayer.ts#L63","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"}]},{"documentation":{"contents":["<p>Destroys the layer and frees all related resources.</p>\n"],"contentsRaw":"Destroys the layer and frees all related resources.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":true,"isRest":false,"isStatic":false},"kind":"method","name":"destroy","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/f6871c9/src/deckgl2gisLayer.ts#L173","signatures":[{"documentation":{"contents":["<p>Destroys the layer and frees all related resources.</p>\n"],"contentsRaw":"Destroys the layer and frees all related resources.","metadata":{}},"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"destroy","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/f6871c9/src/deckgl2gisLayer.ts#L173","parameters":[],"returnType":"void","type":"() => void"}]},{"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/f6871c9/src/deckgl2gisLayer.ts#L158","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/f6871c9/src/deckgl2gisLayer.ts#L158","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/f6871c9/src/deckgl2gisLayer.ts#L55","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/f6871c9/src/deckgl2gisLayer.ts#L52","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/f6871c9/src/deckgl2gisLayer.ts#L54","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/f6871c9/src/deckgl2gisLayer.ts#L48","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":"isDestroyed","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/f6871c9/src/deckgl2gisLayer.ts#L56","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":"map","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/f6871c9/src/deckgl2gisLayer.ts#L51","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/f6871c9/src/deckgl2gisLayer.ts#L53","type":"LayerProps<LayerT> | undefined"},{"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/f6871c9/src/deckgl2gisLayer.ts#L50","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/f6871c9/src/deckgl2gisLayer.ts#L49","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/f6871c9/src/deckgl2gisLayer.ts#L68","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/f6871c9/src/deckgl2gisLayer.ts#L68","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/f6871c9/src/utils.ts#L212","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/f6871c9/src/utils.ts#L212","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/f6871c9/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/f6871c9/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/f6871c9/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/f6871c9/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/f6871c9/src/types.ts#L7","type":"\"custom\""}]},"Deck2gisLayerProps":{"documentation":{"contents":["<p>Deck2gisLayer required props.</p>\n"],"contentsRaw":"Deck2gisLayer required 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/f6871c9/src/deckgl2gisLayer.ts#L30","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/f6871c9/src/deckgl2gisLayer.ts#L35","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/f6871c9/src/deckgl2gisLayer.ts#L33","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/f6871c9/src/deckgl2gisLayer.ts#L31","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/f6871c9/src/deckgl2gisLayer.ts#L32","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/f6871c9/src/deckgl2gisLayer.ts#L34","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/f6871c9/src/types.ts#L50","type":"Partial<DeckProps> & CustomRenderInternalProps"},"DeckLayer":{"documentation":{"contents":["<p>Any Layer class from deck.gl.</p>\n"],"contentsRaw":"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/f6871c9/src/deckgl2gisLayer.ts#L25","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/f6871c9/src/deckgl2gisLayer.ts#L42","type":"Deck2gisLayerProps & Partial<LayerT[\"props\"]>"}}}

dist/types/deckgl2gisLayer.d.ts

@@ -32,5 +32,6 @@ import type { Deck, Layer } from '@deck.gl/core/typed';
     deck: Deck | null;
-    props: LayerProps<LayerT>;
+    props: LayerProps<LayerT> | undefined;
     gl?: WebGLRenderingContext | WebGL2RenderingContext;
     antialiasing: boolean;
+    isDestroyed: boolean;
     /**
@@ -67,2 +68,6 @@ * Initializes deck.gl properties for working with the MapGL map.
     setProps(props: Partial<LayerProps<LayerT>>): void;
+    /**
+     * Destroys the layer and frees all related resources.
+     */
+    destroy: () => void;
 }

package.json

 {
   "name": "@2gis/deck2gis-layer",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/deck2gislayer.js",

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

610933

increased by0.4%

Lines of code

133

increased by3.91%

Worsened metrics

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes