Skip to content

Commit 946d007

Browse files
sjhoeksmasjhoeksma
committed
fix: remove jsdoc
1 parent eb0e6a4 commit 946d007

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+531
-13565
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
node_modules/
33
lowcoder-comp-bpmn-io-*.tgz
44
.DS_Store
5-
package-lock.json
5+
package-lock.json
6+
jsdoc/

‎docs/_sidebar.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* [Home](/)
2+
* [Code](code.md)

‎docs/code.md‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
## Classes
2+
3+
<dl>
4+
<dt><a href="#LayerObjectOption">LayerObjectOption</a></dt>
5+
<dd><p>Creates a LayerObjectOption component using MultiCompBuilder.
6+
Allows configuring properties like label, title, source etc for a layer.
7+
Provides controls for selecting layer type, visibility, opacity etc.
8+
Handles rendering the layer options.</p>
9+
</dd>
10+
</dl>
11+
12+
## Members
13+
14+
<dl>
15+
<dt><a href="#GEOComp">GEOComp</a></dt>
16+
<dd><p>GEOComp Component configuration.
17+
Defines the styling options exposed in the component properties panel.
18+
By setting the following items within default you can control behavior
19+
center:[] will disable automatich centering
20+
debug: true will show eventlog to console</p>
21+
</dd>
22+
<dt><a href="#GEOComp">GEOComp</a></dt>
23+
<dd><p>Exposes methods on GEOComp component to allow calling from parent component.
24+
Includes animate, notify, showPopup, addFeatures, and readFeatures methods.</p>
25+
<p>animate: Perform animation on map.
26+
notify: Display notification message.
27+
showPopup: Show popup at coordinates with message.
28+
addFeatures: Add feature to layer.
29+
readFeatures: Read feature from layer.</p>
30+
</dd>
31+
<dt><a href="#LayerObjectOption">LayerObjectOption</a></dt>
32+
<dd><p>Creates a LayerObjectOption component using MultiCompBuilder.
33+
Allows configuring properties like label, title, source etc for a layer.
34+
Provides controls for selecting layer type, visibility, opacity etc.
35+
Handles rendering the layer options.</p>
36+
</dd>
37+
</dl>
38+
39+
## Constants
40+
41+
<dl>
42+
<dt><a href="#CompStyles">CompStyles</a></dt>
43+
<dd><p>Array of style configuration objects for styling the component.
44+
Each object has a name, label, and style property key.</p>
45+
</dd>
46+
<dt><a href="#geoContext">geoContext</a></dt>
47+
<dd><p>Object that contains the previewMode value which indicates if the app is in preview mode.
48+
previewMode is set based on the existence of the lowcoderdev global.</p>
49+
</dd>
50+
</dl>
51+
52+
## Functions
53+
54+
<dl>
55+
<dt><a href="#featureControl">featureControl()</a></dt>
56+
<dd><p>Generates a feature control component by mapping feature flag keys
57+
to boolean controls.</p>
58+
<p>Accepts a config object with feature flag keys mapped to their default
59+
enabled values. Renders boolean controls for each feature flag, with
60+
getView() returning the current enabled state of each flag.</p>
61+
</dd>
62+
<dt><a href="#SourceControl">SourceControl()</a></dt>
63+
<dd><p>Creates a SourceControl component that allows configuring the source
64+
parameters for a map layer. It is a customized MultiCompBuilder that
65+
generates different source parameters based on the layer type.
66+
The propertyView method renders a UI for configuring the relevant
67+
source parameters.</p>
68+
</dd>
69+
<dt><a href="#layersControl">layersControl()</a></dt>
70+
<dd><p>Creates a LayersControl component using MultiCompBuilder to configure layer options.
71+
Allows selecting layer type, visibility, opacity etc.
72+
Handles rendering the layer options and returns the LayersControl class.</p>
73+
</dd>
74+
</dl>
75+
76+
<a name="LayerObjectOption"></a>
77+
78+
## LayerObjectOption
79+
Creates a LayerObjectOption component using MultiCompBuilder.
80+
Allows configuring properties like label, title, source etc for a layer.
81+
Provides controls for selecting layer type, visibility, opacity etc.
82+
Handles rendering the layer options.
83+
84+
**Kind**: global class
85+
<a name="GEOComp"></a>
86+
87+
## GEOComp
88+
GEOComp Component configuration.
89+
Defines the styling options exposed in the component properties panel.
90+
By setting the following items within default you can control behavior
91+
center:[] will disable automatich centering
92+
debug: true will show eventlog to console
93+
94+
**Kind**: global variable
95+
<a name="GEOComp"></a>
96+
97+
## GEOComp
98+
Exposes methods on GEOComp component to allow calling from parent component.
99+
Includes animate, notify, showPopup, addFeatures, and readFeatures methods.
100+
101+
animate: Perform animation on map.
102+
notify: Display notification message.
103+
showPopup: Show popup at coordinates with message.
104+
addFeatures: Add feature to layer.
105+
readFeatures: Read feature from layer.
106+
107+
**Kind**: global variable
108+
<a name="LayerObjectOption"></a>
109+
110+
## LayerObjectOption
111+
Creates a LayerObjectOption component using MultiCompBuilder.
112+
Allows configuring properties like label, title, source etc for a layer.
113+
Provides controls for selecting layer type, visibility, opacity etc.
114+
Handles rendering the layer options.
115+
116+
**Kind**: global variable
117+
<a name="CompStyles"></a>
118+
119+
## CompStyles
120+
Array of style configuration objects for styling the component.
121+
Each object has a name, label, and style property key.
122+
123+
**Kind**: global constant
124+
<a name="geoContext"></a>
125+
126+
## geoContext
127+
Object that contains the previewMode value which indicates if the app is in preview mode.
128+
previewMode is set based on the existence of the lowcoderdev global.
129+
130+
**Kind**: global constant
131+
<a name="featureControl"></a>
132+
133+
## featureControl()
134+
Generates a feature control component by mapping feature flag keys
135+
to boolean controls.
136+
137+
Accepts a config object with feature flag keys mapped to their default
138+
enabled values. Renders boolean controls for each feature flag, with
139+
getView() returning the current enabled state of each flag.
140+
141+
**Kind**: global function
142+
<a name="SourceControl"></a>
143+
144+
## SourceControl()
145+
Creates a SourceControl component that allows configuring the source
146+
parameters for a map layer. It is a customized MultiCompBuilder that
147+
generates different source parameters based on the layer type.
148+
The propertyView method renders a UI for configuring the relevant
149+
source parameters.
150+
151+
**Kind**: global function
152+
<a name="layersControl"></a>
153+
154+
## layersControl()
155+
Creates a LayersControl component using MultiCompBuilder to configure layer options.
156+
Allows selecting layer type, visibility, opacity etc.
157+
Handles rendering the layer options and returns the LayersControl class.
158+
159+
**Kind**: global function

‎docs/index.html‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,39 @@
1515
<script>
1616
window.$docsify = {
1717
name: 'lowcoder-comp-geo',
18-
repo: 'sjhoeksma/lowcoder-comp-geo'
18+
repo: 'sjhoeksma/lowcoder-comp-geo',
19+
loadSidebar: true,
20+
21+
search: {
22+
maxAge: 86400000, // Expiration time, the default one day
23+
paths: ['/',
24+
'/code'],
25+
placeholder: 'Type to search',
26+
27+
noData: 'No Results!',
28+
29+
// Localization
30+
noData: {
31+
'/': 'No Results',
32+
},
33+
34+
// Headline depth, 1 - 6
35+
depth: 2,
36+
37+
hideOtherSidebarContent: false, // whether or not to hide other sidebar content
38+
39+
},
40+
copyCode: {
41+
buttonText: 'Copy',
42+
errorText: 'Error',
43+
successText: 'Copied',
44+
},
1945
}
2046
</script>
2147
<!-- Docsify v4 -->
2248
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
49+
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
50+
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
2351
</body>
2452

2553
</html>

‎jsdoc.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"plugins": [
1313
"node_modules/better-docs/typescript",
1414
"node_modules/better-docs/component",
15-
"node_modules/better-docs/category"
15+
"node_modules/better-docs/category",
16+
"plugins/markdown"
1617
],
1718
"source": {
1819
"includePattern": "\\.(jsx|js|ts|tsx)$"

0 commit comments

Comments
 (0)