|
| 1 | +### ChartType |
| 2 | + |
| 3 | +Chart types |
| 4 | + |
| 5 | +#### Enumeration Members |
| 6 | + |
| 7 | +| Enumeration Member | Value | |
| 8 | +| ------ | ------ | |
| 9 | +| `BAR` | `"bar"` | |
| 10 | +| `BOX_AND_WHISKER` | `"box_and_whisker"` | |
| 11 | +| `LINE` | `"line"` | |
| 12 | +| `PIE` | `"pie"` | |
| 13 | +| `SCATTER` | `"scatter"` | |
| 14 | +| `SUPERCHART` | `"superchart"` | |
| 15 | +| `UNKNOWN` | `"unknown"` | |
| 16 | + |
| 17 | +*** |
| 18 | + |
| 19 | +### ScaleType |
| 20 | + |
| 21 | +Ax scale types |
| 22 | + |
| 23 | +#### Enumeration Members |
| 24 | + |
| 25 | +| Enumeration Member | Value | |
| 26 | +| ------ | ------ | |
| 27 | +| `ASINH` | `"asinh"` | |
| 28 | +| `CATEGORICAL` | `"categorical"` | |
| 29 | +| `DATETIME` | `"datetime"` | |
| 30 | +| `FUNCTION` | `"function"` | |
| 31 | +| `FUNCTIONLOG` | `"functionlog"` | |
| 32 | +| `LINEAR` | `"linear"` | |
| 33 | +| `LOG` | `"log"` | |
| 34 | +| `LOGIT` | `"logit"` | |
| 35 | +| `SYMLOG` | `"symlog"` | |
| 36 | + |
| 37 | +## Type Aliases |
| 38 | + |
| 39 | +### BarChart |
| 40 | + |
| 41 | +```ts |
| 42 | +type BarChart: Chart2D & object; |
| 43 | +``` |
| 44 | + |
| 45 | +#### Type declaration |
| 46 | + |
| 47 | +| Name | Type | |
| 48 | +| ------ | ------ | |
| 49 | +| `elements` | `BarData`[] | |
| 50 | +| `type` | `ChartType.BAR` | |
| 51 | + |
| 52 | +*** |
| 53 | + |
| 54 | +### BarData |
| 55 | + |
| 56 | +```ts |
| 57 | +type BarData: object; |
| 58 | +``` |
| 59 | + |
| 60 | +#### Type declaration |
| 61 | + |
| 62 | +| Name | Type | |
| 63 | +| ------ | ------ | |
| 64 | +| `group` | `string` | |
| 65 | +| `label` | `string` | |
| 66 | +| `value` | `string` | |
| 67 | + |
| 68 | +*** |
| 69 | + |
| 70 | +### BoxAndWhiskerChart |
| 71 | + |
| 72 | +```ts |
| 73 | +type BoxAndWhiskerChart: Chart2D & object; |
| 74 | +``` |
| 75 | + |
| 76 | +#### Type declaration |
| 77 | + |
| 78 | +| Name | Type | |
| 79 | +| ------ | ------ | |
| 80 | +| `elements` | `BoxAndWhiskerData`[] | |
| 81 | +| `type` | `ChartType.BOX_AND_WHISKER` | |
| 82 | + |
| 83 | +*** |
| 84 | + |
| 85 | +### BoxAndWhiskerData |
| 86 | + |
| 87 | +```ts |
| 88 | +type BoxAndWhiskerData: object; |
| 89 | +``` |
| 90 | + |
| 91 | +#### Type declaration |
| 92 | + |
| 93 | +| Name | Type | |
| 94 | +| ------ | ------ | |
| 95 | +| `first_quartile` | `number` | |
| 96 | +| `label` | `string` | |
| 97 | +| `max` | `number` | |
| 98 | +| `median` | `number` | |
| 99 | +| `min` | `number` | |
| 100 | +| `outliers` | `number`[] | |
| 101 | +| `third_quartile` | `number` | |
| 102 | + |
| 103 | +*** |
| 104 | + |
| 105 | +### Chart |
| 106 | + |
| 107 | +```ts |
| 108 | +type Chart: object; |
| 109 | +``` |
| 110 | + |
| 111 | +Represents a chart. |
| 112 | + |
| 113 | +#### Type declaration |
| 114 | + |
| 115 | +| Name | Type | |
| 116 | +| ------ | ------ | |
| 117 | +| `elements` | `any`[] | |
| 118 | +| `title` | `string` | |
| 119 | +| `type` | `ChartType` | |
| 120 | + |
| 121 | +*** |
| 122 | + |
| 123 | +### ChartTypes |
| 124 | + |
| 125 | +```ts |
| 126 | +type ChartTypes: |
| 127 | + | LineChart |
| 128 | + | ScatterChart |
| 129 | + | BarChart |
| 130 | + | PieChart |
| 131 | + | BoxAndWhiskerChart |
| 132 | + | SuperChart; |
| 133 | +``` |
| 134 | + |
| 135 | +*** |
| 136 | + |
| 137 | +### LineChart |
| 138 | + |
| 139 | +```ts |
| 140 | +type LineChart: PointChart & object; |
| 141 | +``` |
| 142 | + |
| 143 | +#### Type declaration |
| 144 | + |
| 145 | +| Name | Type | |
| 146 | +| ------ | ------ | |
| 147 | +| `type` | `ChartType.LINE` | |
| 148 | + |
| 149 | +*** |
| 150 | + |
| 151 | +### PieChart |
| 152 | + |
| 153 | +```ts |
| 154 | +type PieChart: Chart & object; |
| 155 | +``` |
| 156 | + |
| 157 | +#### Type declaration |
| 158 | + |
| 159 | +| Name | Type | |
| 160 | +| ------ | ------ | |
| 161 | +| `elements` | `PieData`[] | |
| 162 | +| `type` | `ChartType.PIE` | |
| 163 | + |
| 164 | +*** |
| 165 | + |
| 166 | +### PieData |
| 167 | + |
| 168 | +```ts |
| 169 | +type PieData: object; |
| 170 | +``` |
| 171 | + |
| 172 | +#### Type declaration |
| 173 | + |
| 174 | +| Name | Type | |
| 175 | +| ------ | ------ | |
| 176 | +| `angle` | `number` | |
| 177 | +| `label` | `string` | |
| 178 | +| `radius` | `number` | |
| 179 | + |
| 180 | +*** |
| 181 | + |
| 182 | +### PointData |
| 183 | + |
| 184 | +```ts |
| 185 | +type PointData: object; |
| 186 | +``` |
| 187 | + |
| 188 | +#### Type declaration |
| 189 | + |
| 190 | +| Name | Type | |
| 191 | +| ------ | ------ | |
| 192 | +| `label` | `string` | |
| 193 | +| `points` | [`number` \| `string`, `number` \| `string`][] | |
| 194 | + |
| 195 | +*** |
| 196 | + |
| 197 | +### ScatterChart |
| 198 | + |
| 199 | +```ts |
| 200 | +type ScatterChart: PointChart & object; |
| 201 | +``` |
| 202 | + |
| 203 | +#### Type declaration |
| 204 | + |
| 205 | +| Name | Type | |
| 206 | +| ------ | ------ | |
| 207 | +| `type` | `ChartType.SCATTER` | |
| 208 | + |
| 209 | +*** |
| 210 | + |
| 211 | +### SuperChart |
| 212 | + |
| 213 | +```ts |
| 214 | +type SuperChart: Chart & object; |
| 215 | +``` |
| 216 | + |
| 217 | +#### Type declaration |
| 218 | + |
| 219 | +| Name | Type | |
| 220 | +| ------ | ------ | |
| 221 | +| `elements` | `Chart`[] | |
| 222 | +| `type` | `ChartType.SUPERCHART` | |
| 223 | + |
| 224 | +## Functions |
| 225 | + |
| 226 | +### deserializeChart() |
| 227 | + |
| 228 | +```ts |
| 229 | +function deserializeChart(data: any): Chart |
| 230 | +``` |
| 231 | + |
| 232 | +#### Parameters |
| 233 | + |
| 234 | +| Parameter | Type | |
| 235 | +| ------ | ------ | |
| 236 | +| `data` | `any` | |
| 237 | + |
| 238 | +#### Returns |
| 239 | + |
| 240 | +`Chart` |
0 commit comments