@nebula.js/sn-text 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,49 +3,222 @@
3
3
  "info": {
4
4
  "name": "@nebula.js/sn-text:properties",
5
5
  "description": "Advanced Text object definition",
6
- "version": "1.0.0",
6
+ "version": "1.1.1",
7
7
  "license": "MIT",
8
- "stability": "experimental",
8
+ "stability": "stable",
9
9
  "x-qlik-visibility": "public"
10
10
  },
11
- "entries": {},
11
+ "entries": {
12
+ "properties": {
13
+ "extends": [
14
+ {
15
+ "type": "EngineAPI.GenericObjectProperties"
16
+ }
17
+ ],
18
+ "kind": "object",
19
+ "entries": {
20
+ "showTitles": {
21
+ "optional": true,
22
+ "type": "boolean"
23
+ },
24
+ "title": {
25
+ "optional": true,
26
+ "kind": "union",
27
+ "items": [
28
+ {
29
+ "type": "string"
30
+ },
31
+ {
32
+ "type": "EngineAPI.StringExpression"
33
+ }
34
+ ]
35
+ },
36
+ "subtitle": {
37
+ "optional": true,
38
+ "kind": "union",
39
+ "items": [
40
+ {
41
+ "type": "string"
42
+ },
43
+ {
44
+ "type": "EngineAPI.StringExpression"
45
+ }
46
+ ]
47
+ },
48
+ "footnote": {
49
+ "optional": true,
50
+ "kind": "union",
51
+ "items": [
52
+ {
53
+ "type": "string"
54
+ },
55
+ {
56
+ "type": "EngineAPI.StringExpression"
57
+ }
58
+ ]
59
+ },
60
+ "version": {
61
+ "description": "Current version of this generic object definition",
62
+ "type": "string"
63
+ },
64
+ "fontsUsed": {
65
+ "description": "A list of font families used in the text.",
66
+ "optional": true,
67
+ "nullable": true,
68
+ "kind": "array",
69
+ "items": {
70
+ "type": "string"
71
+ }
72
+ },
73
+ "components": {
74
+ "description": "A list of styling components",
75
+ "optional": true,
76
+ "nullable": true,
77
+ "kind": "array",
78
+ "items": {
79
+ "type": "#/definitions/Component"
80
+ }
81
+ },
82
+ "qHyperCubeDef": {
83
+ "description": "see Engine API: `HyperCubeDef`.",
84
+ "extends": [
85
+ {
86
+ "type": "EngineAPI.HyperCubeDef"
87
+ }
88
+ ],
89
+ "kind": "object",
90
+ "entries": {
91
+ "qMeasures": {
92
+ "description": "see Engine API: `NxMeasure`.",
93
+ "kind": "array",
94
+ "items": {
95
+ "type": "EngineAPI.NxMeasure"
96
+ }
97
+ },
98
+ "qSuppressZero": {
99
+ "defaultValue": false,
100
+ "type": "boolean"
101
+ },
102
+ "qSuppressMissing": {
103
+ "defaultValue": true,
104
+ "type": "boolean"
105
+ }
106
+ }
107
+ }
108
+ }
109
+ }
110
+ },
12
111
  "definitions": {
13
- "properties.version": {
14
- "description": "Current version of this generic object definition",
15
- "type": "string"
16
- },
17
- "properties.title": {
18
- "optional": true,
19
- "defaultValue": "",
20
- "type": "string"
112
+ "Component": {
113
+ "kind": "alias",
114
+ "items": {
115
+ "kind": "union",
116
+ "items": [
117
+ {
118
+ "type": "#/definitions/GeneralStyling"
119
+ },
120
+ {
121
+ "type": "object"
122
+ }
123
+ ]
124
+ }
21
125
  },
22
- "properties.subtitle": {
23
- "optional": true,
24
- "defaultValue": "",
25
- "type": "string"
126
+ "GeneralStyling": {
127
+ "kind": "object",
128
+ "entries": {
129
+ "key": {
130
+ "description": "Determines which component the settings apply to (must be \"general\" for general styling)",
131
+ "optional": true,
132
+ "defaultValue": "\"general\"",
133
+ "type": "string"
134
+ },
135
+ "bgColor": {
136
+ "type": "#/definitions/ColorConfig"
137
+ },
138
+ "bgImage": {
139
+ "type": "#/definitions/ImageConfig"
140
+ },
141
+ "title": {
142
+ "type": "#/definitions/TitleConfig"
143
+ }
144
+ }
26
145
  },
27
- "properties.footnote": {
28
- "optional": true,
29
- "defaultValue": "",
30
- "type": "string"
146
+ "TitleConfig": {
147
+ "kind": "object",
148
+ "entries": {
149
+ "main": {
150
+ "description": "Styling of main title",
151
+ "type": "#/definitions/FontStyling"
152
+ },
153
+ "subtitle": {
154
+ "description": "Styling of subtitle",
155
+ "type": "#/definitions/FontStyling"
156
+ },
157
+ "footer": {
158
+ "description": "Styling of footer",
159
+ "type": "#/definitions/FontStyling"
160
+ }
161
+ }
31
162
  },
32
- "properties.showTitles": {
33
- "defaultValue": false,
34
- "type": "boolean"
163
+ "FontStyling": {
164
+ "kind": "object",
165
+ "entries": {
166
+ "color": {
167
+ "description": "Color configuration",
168
+ "type": "#/definitions/ColorConfig"
169
+ },
170
+ "fontFamily": {
171
+ "type": "string"
172
+ },
173
+ "fontSize": {
174
+ "type": "string"
175
+ },
176
+ "fontStyle": {
177
+ "kind": "array",
178
+ "items": {
179
+ "type": "string"
180
+ }
181
+ }
182
+ }
35
183
  },
36
- "properties.qHyperCubeDef.qMeasures": {
37
- "kind": "array",
38
- "items": {
39
- "type": "NxMeasure"
184
+ "ImageConfig": {
185
+ "kind": "object",
186
+ "entries": {
187
+ "mediaUrl": {
188
+ "type": "object"
189
+ },
190
+ "mode": {
191
+ "type": "string"
192
+ },
193
+ "position": {
194
+ "type": "string"
195
+ },
196
+ "sizing": {
197
+ "type": "string"
198
+ }
40
199
  }
41
200
  },
42
- "properties.qHyperCubeDef.qSuppressZero": {
43
- "defaultValue": false,
44
- "type": "boolean"
201
+ "mediaUrl": {
202
+ "kind": "object",
203
+ "entries": {
204
+ "qStaticContentUrlDef": {
205
+ "type": "EngineAPI.StaticContentUrlDef"
206
+ }
207
+ }
45
208
  },
46
- "properties.qHyperCubeDef.qSuppressMissing": {
47
- "defaultValue": true,
48
- "type": "boolean"
209
+ "ColorConfig": {
210
+ "description": "Represents the default color configuration for a component.",
211
+ "kind": "object",
212
+ "entries": {
213
+ "index": {
214
+ "description": "The index of the color.",
215
+ "type": "number"
216
+ },
217
+ "color": {
218
+ "description": "The color.",
219
+ "type": "string"
220
+ }
221
+ }
49
222
  }
50
223
  }
51
224
  }