@2gis/deck2gis-layer
Advanced tools
Comparing version 2.0.0-alpha-0.1 to 2.0.0-alpha-0.2
@@ -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/3feb347/src/deckgl2gisLayer.ts#L42","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":"initDeck2gis","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/deckgl2gisLayer.ts#L58","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":"initDeck2gis","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/deckgl2gisLayer.ts#L58","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"},{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"Deck","type":"Deck"},{"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":"Deck<>","type":"(map: Map, Deck: Deck, deckProps?: CustomRenderProps) => Deck<>"}]},{"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/3feb347/src/deckgl2gisLayer.ts#L160","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/3feb347/src/deckgl2gisLayer.ts#L160","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":"getDeckLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/deckgl2gisLayer.ts#L148","signatures":[{"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"getDeckLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/deckgl2gisLayer.ts#L148","parameters":[],"returnType":"Layer","type":"() => Layer"}]},{"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/3feb347/src/deckgl2gisLayer.ts#L136","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/3feb347/src/deckgl2gisLayer.ts#L136","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/3feb347/src/deckgl2gisLayer.ts#L50","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/3feb347/src/deckgl2gisLayer.ts#L47","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/3feb347/src/deckgl2gisLayer.ts#L49","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/3feb347/src/deckgl2gisLayer.ts#L43","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/3feb347/src/deckgl2gisLayer.ts#L51","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/3feb347/src/deckgl2gisLayer.ts#L46","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/3feb347/src/deckgl2gisLayer.ts#L48","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/3feb347/src/deckgl2gisLayer.ts#L45","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/3feb347/src/deckgl2gisLayer.ts#L44","type":"\"custom\""}],"accessors":[],"constructorType":{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const 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);</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/3feb347/src/deckgl2gisLayer.ts#L59","signatures":[{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const 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);</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/3feb347/src/deckgl2gisLayer.ts#L59","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"}]}},"initDeck2gis":{"fileName":"src/utils.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"method","name":"initDeck2gis","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/utils.ts#L320","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":"initDeck2gis","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/utils.ts#L320","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"},{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"Deck","type":"any"},{"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":"Deck","type":"(map: Map, Deck: any, deckProps?: CustomRenderProps) => Deck"}]},"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/3feb347/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/3feb347/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/3feb347/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/3feb347/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/3feb347/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/3feb347/src/deckgl2gisLayer.ts#L25","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/3feb347/src/deckgl2gisLayer.ts#L30","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/3feb347/src/deckgl2gisLayer.ts#L28","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/3feb347/src/deckgl2gisLayer.ts#L26","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/3feb347/src/deckgl2gisLayer.ts#L27","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/3feb347/src/deckgl2gisLayer.ts#L29","type":"DeckLayer"}]},"AntiAliasingMode":{"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":"AntiAliasingMode","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/types.ts#L48","type":"\"fxaa\" | \"msaa\" | \"none\""},"CustomRenderProps":{"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/3feb347/src/types.ts#L50","type":""},"DeckRenderProps":{"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":"DeckRenderProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/types.ts#L59","type":"Partial<DeckProps> & CustomRenderProps"},"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/3feb347/src/deckgl2gisLayer.ts#L20","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/3feb347/src/deckgl2gisLayer.ts#L37","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/3feb347/src/deckgl2gisLayer.ts#L42","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":"initDeck2gis","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/deckgl2gisLayer.ts#L58","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":"initDeck2gis","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/deckgl2gisLayer.ts#L58","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"},{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"Deck","type":"Deck"},{"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":"Deck<>","type":"(map: Map, Deck: Deck, deckProps?: CustomRenderProps) => Deck<>"}]},{"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/3feb347/src/deckgl2gisLayer.ts#L160","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/3feb347/src/deckgl2gisLayer.ts#L160","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":"getDeckLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/deckgl2gisLayer.ts#L148","signatures":[{"fileName":"src/deckgl2gisLayer.ts","kind":"signature","name":"getDeckLayer","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/deckgl2gisLayer.ts#L148","parameters":[],"returnType":"Layer","type":"() => Layer"}]},{"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/3feb347/src/deckgl2gisLayer.ts#L136","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/3feb347/src/deckgl2gisLayer.ts#L136","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/3feb347/src/deckgl2gisLayer.ts#L50","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/3feb347/src/deckgl2gisLayer.ts#L47","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/3feb347/src/deckgl2gisLayer.ts#L49","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/3feb347/src/deckgl2gisLayer.ts#L43","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/3feb347/src/deckgl2gisLayer.ts#L51","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/3feb347/src/deckgl2gisLayer.ts#L46","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/3feb347/src/deckgl2gisLayer.ts#L48","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/3feb347/src/deckgl2gisLayer.ts#L45","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/3feb347/src/deckgl2gisLayer.ts#L44","type":"\"custom\""}],"accessors":[],"constructorType":{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const 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);</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/3feb347/src/deckgl2gisLayer.ts#L59","signatures":[{"documentation":{"contents":["<p>Example:</p>\n<pre><code class=\"language-js\">const 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);</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/3feb347/src/deckgl2gisLayer.ts#L59","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"}]}},"initDeck2gis":{"fileName":"src/utils.ts","flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"method","name":"initDeck2gis","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/utils.ts#L333","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":"initDeck2gis","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/utils.ts#L333","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"},{"flags":{"isExported":true,"isExternal":false,"isOptional":false,"isPrivate":false,"isProtected":false,"isPublic":false,"isRest":false,"isStatic":false},"kind":"parameter","name":"Deck","type":"any"},{"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":"Deck","type":"(map: Map, Deck: any, deckProps?: CustomRenderProps) => Deck"}]},"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/3feb347/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/3feb347/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/3feb347/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/3feb347/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/3feb347/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/3feb347/src/deckgl2gisLayer.ts#L25","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/3feb347/src/deckgl2gisLayer.ts#L30","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/3feb347/src/deckgl2gisLayer.ts#L28","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/3feb347/src/deckgl2gisLayer.ts#L26","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/3feb347/src/deckgl2gisLayer.ts#L27","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/3feb347/src/deckgl2gisLayer.ts#L29","type":"DeckLayer"}]},"AntiAliasingMode":{"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":"AntiAliasingMode","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/types.ts#L48","type":"\"fxaa\" | \"msaa\" | \"none\""},"CustomRenderProps":{"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/3feb347/src/types.ts#L50","type":""},"DeckRenderProps":{"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":"DeckRenderProps","sourceUrl":"https://github.com/2gis/deck2gisLayer/blob/3feb347/src/types.ts#L59","type":"Partial<DeckProps> & CustomRenderProps"},"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/3feb347/src/deckgl2gisLayer.ts#L20","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/3feb347/src/deckgl2gisLayer.ts#L37","type":"Deck2gisLayerProps & Partial<LayerT[\"props\"]>"}}} |
{ | ||
"name": "@2gis/deck2gis-layer", | ||
"version": "2.0.0-alpha-0.1", | ||
"version": "2.0.0-alpha-0.2", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "dist/deck2gislayer.js", |
Sorry, the diff of this file is too big to display
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
0
123860
11
102