1/* * 2 * 3 * (c) 2010-2024 Torstein Honsi 4 * 5 * License: www.highcharts.com/license 6 * 7 * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! 8 * 9 * */ 10'use strict'; 11/* * 12 * 13 * API Options 14 * 15 * */ 16/** 17 * Column series display one column per value along an X axis. 18 * 19 * @sample {highcharts} highcharts/demo/column-basic/ 20 * Column chart 21 * @sample {highstock} stock/demo/column/ 22 * Column chart 23 * 24 * @extends plotOptions.line 25 * @excluding connectEnds, connectNulls, gapSize, gapUnit, linecap, 26 * lineWidth, marker, step, useOhlcData 27 * @product highcharts highstock 28 * @optionparent plotOptions.column 29 */ 30const ColumnSeriesDefaults = { 31 /** 32 * The corner radius of the border surrounding each column or bar. A number 33 * signifies pixels. A percentage string, like for example `50%`, signifies 34 * a relative size. For columns this is relative to the column width, for 35 * pies it is relative to the radius and the inner radius. 36 * 37 * @sample {highcharts} highcharts/plotoptions/column-borderradius/ 38 * Rounded columns 39 * @sample highcharts/plotoptions/series-border-radius 40 * Column and pie with rounded border 41 * 42 * @type {number|string|Highcharts.BorderRadiusOptionsObject} 43 * @product highcharts highstock gantt 44 */ 45 borderRadius: 3, 46 /** 47 * When using automatic point colors pulled from the global 48 * [colors](colors) or series-specific 49 * [plotOptions.column.colors](series.colors) collections, this option 50 * determines whether the chart should receive one color per series or 51 * one color per point. 52 * 53 * In styled mode, the `colors` or `series.colors` arrays are not 54 * supported, and instead this option gives the points individual color 55 * class names on the form `highcharts-color-{n}`. 56 * 57 * @see [series colors](#plotOptions.column.colors) 58 * 59 * @sample {highcharts} highcharts/plotoptions/column-colorbypoint-false/ 60 * False by default 61 * @sample {highcharts} highcharts/plotoptions/column-colorbypoint-true/ 62 * True 63 * 64 * @type {boolean} 65 * @default false 66 * @since 2.0 67 * @product highcharts highstock gantt 68 * @apioption plotOptions.column.colorByPoint 69 */ 70 /** 71 * A series specific or series type specific color set to apply instead 72 * of the global [colors](#colors) when [colorByPoint]( 73 * #plotOptions.column.colorByPoint) is true. 74 * 75 * @type {Array<Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject>} 76 * @since 3.0 77 * @product highcharts highstock gantt 78 * @apioption plotOptions.column.colors 79 */ 80 /** 81 * When `true`, the columns will center in the category, ignoring null 82 * or missing points. When `false`, space will be reserved for null or 83 * missing points. 84 * 85 * @sample {highcharts} highcharts/series-column/centerincategory/ 86 * Center in category 87 * @sample {highcharts} highcharts/series/stack-centerincategory/ 88 * Center in category, stacked and grouped 89 * 90 * @since 8.0.1 91 * @product highcharts highstock gantt 92 */ 93 centerInCategory: false, 94 /** 95 * Padding between each value groups, in x axis units. 96 * 97 * @sample {highcharts} highcharts/plotoptions/column-grouppadding-default/ 98 * 0.2 by default 99 * @sample {highcharts} highcharts/plotoptions/column-grouppadding-none/ 100 * No group padding - all columns are evenly spaced 101 * 102 * @product highcharts highstock gantt 103 */ 104 groupPadding: 0.2, 105 /** 106 * Whether to group non-stacked columns or to let them render 107 * independent of each other. Non-grouped columns will be laid out 108 * individually and overlap each other. 109 * 110 * @sample {highcharts} highcharts/plotoptions/column-grouping-false/ 111 * Grouping disabled 112 * @sample {highstock} highcharts/plotoptions/column-grouping-false/ 113 * Grouping disabled 114 * 115 * @type {boolean} 116 * @default true 117 * @since 2.3.0 118 * @product highcharts highstock gantt 119 * @apioption plotOptions.column.grouping 120 */ 121 /** @ignore-option */ 122 marker: null, // Point options are specified in the base options 123 /** 124 * The maximum allowed pixel width for a column, translated to the 125 * height of a bar in a bar chart. This prevents the columns from 126 * becoming too wide when there is a small number of points in the 127 * chart. 128 * 129 * @see [pointWidth](#plotOptions.column.pointWidth) 130 * 131 * @sample {highcharts} highcharts/plotoptions/column-maxpointwidth-20/ 132 * Limited to 50 133 * @sample {highstock} highcharts/plotoptions/column-maxpointwidth-20/ 134 * Limited to 50 135 * 136 * @type {number} 137 * @since 4.1.8 138 * @product highcharts highstock gantt 139 * @apioption plotOptions.column.maxPointWidth 140 */ 141 /** 142 * Padding between each column or bar, in x axis units. 143 * 144 * @sample {highcharts} highcharts/plotoptions/column-pointpadding-default/ 145 * 0.1 by default 146 * @sample {highcharts} highcharts/plotoptions/column-pointpadding-025/ 147 * 0.25 148 * @sample {highcharts} highcharts/plotoptions/column-pointpadding-none/ 149 * 0 for tightly packed columns 150 * 151 * @product highcharts highstock gantt 152 */ 153 pointPadding: 0.1, 154 /** 155 * A pixel value specifying a fixed width for each column or bar point. 156 * When set to `undefined`, the width is calculated from the 157 * `pointPadding` and `groupPadding`. The width effects the dimension 158 * that is not based on the point value. For column series it is the 159 * horizontal length and for bar series it is the vertical length. 160 * 161 * @see [maxPointWidth](#plotOptions.column.maxPointWidth) 162 * 163 * @sample {highcharts} highcharts/plotoptions/column-pointwidth-20/ 164 * 20px wide columns regardless of chart width or the amount of 165 * data points 166 * 167 * @type {number} 168 * @since 1.2.5 169 * @product highcharts highstock gantt 170 * @apioption plotOptions.column.pointWidth 171 */ 172 /** 173 * A pixel value specifying a fixed width for the column or bar. 174 * Overrides pointWidth on the series. 175 * 176 * @see [series.pointWidth](#plotOptions.column.pointWidth) 177 * 178 * @type {number} 179 * @default undefined 180 * @since 7.0.0 181 * @product highcharts highstock gantt 182 * @apioption series.column.data.pointWidth 183 */ 184 /** 185 * The minimal height for a column or width for a bar. By default, 186 * 0 values are not shown. To visualize a 0 (or close to zero) point, 187 * set the minimal point length to a pixel value like 3\. In stacked 188 * column charts, minPointLength might not be respected for tightly 189 * packed values. 190 * 191 * @sample {highcharts} highcharts/plotoptions/column-minpointlength/ 192 * Zero base value 193 * @sample {highcharts} highcharts/plotoptions/column-minpointlength-pos-and-neg/ 194 * Positive and negative close to zero values 195 * 196 * @product highcharts highstock gantt 197 */ 198 minPointLength: 0, 199 /** 200 * When the series contains less points than the crop threshold, all 201 * points are drawn, event if the points fall outside the visible plot 202 * area at the current zoom. The advantage of drawing all points 203 * (including markers and columns), is that animation is performed on
204 * updates. On the other hand, when the series contains more points than 205 * the crop threshold, the series data is cropped to only contain points 206 * that fall within the plot area. The advantage of cropping away 207 * invisible points is to increase performance on large series. 208 * 209 * @product highcharts highstock gantt 210 */ 211 cropThreshold: 50, 212 /** 213 * The X axis range that each point is valid for. This determines the 214 * width of the column. On a categorized axis, the range will be 1 215 * by default (one category unit). On linear and datetime axes, the 216 * range will be computed as the distance between the two closest data 217 * points. 218 * 219 * The default `null` means it is computed automatically, but this 220 * option can be used to override the automatic value. 221 * 222 * This option is set by default to 1 if data sorting is enabled. 223 * 224 * @sample {highcharts} highcharts/plotoptions/column-pointrange/ 225 * Set the point range to one day on a data set with one week 226 * between the points 227 * 228 * @type {number|null} 229 * @since 2.3 230 * @product highcharts highstock gantt 231 */ 232 pointRange: null, 233 states: { 234 /** 235 * Options for the hovered point. These settings override the normal 236 * state options when a point is moused over or touched. 237 * 238 * @extends plotOptions.series.states.hover 239 * @excluding halo, lineWidth, lineWidthPlus, marker 240 * @product highcharts highstock gantt 241 */ 242 hover: { 243 /** @ignore-option */ 244 halo: false, 245 /** 246 * A specific border color for the hovered point. Defaults to 247 * inherit the normal state border color. 248 * 249 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 250 * @product highcharts gantt 251 * @apioption plotOptions.column.states.hover.borderColor 252 */ 253 /** 254 * A specific color for the hovered point. 255 * 256 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 257 * @product highcharts gantt 258 * @apioption plotOptions.column.states.hover.color 259 */ 260 /** 261 * How much to brighten the point on interaction. Requires the 262 * main color to be defined in hex or rgb(a) format. 263 * 264 * In styled mode, the hover brightening is by default replaced 265 * with a fill-opacity set in the `.highcharts-point:hover` 266 * rule. 267 * 268 * @sample {highcharts} highcharts/plotoptions/column-states-hover-brightness/ 269 * Brighten by 0.5 270 * 271 * @product highcharts highstock gantt 272 */ 273 brightness: 0.1 274 }, 275 /** 276 * Options for the selected point. These settings override the 277 * normal state options when a point is selected. 278 * 279 * @extends plotOptions.series.states.select 280 * @excluding halo, lineWidth, lineWidthPlus, marker 281 * @product highcharts highstock gantt 282 */ 283 select: { 284 /** 285 * A specific color for the selected point. 286 * 287 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 288 * @default #cccccc 289 * @product highcharts highstock gantt 290 */ 291 color: "#cccccc" /* Palette.neutralColor20 */, 292 /** 293 * A specific border color for the selected point. 294 * 295 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 296 * @default #000000 297 * @product highcharts highstock gantt 298 */ 299 borderColor: "#000000" /* Palette.neutralColor100 */ 300 } 301 }, 302 dataLabels: { 303 align: void 0, 304 verticalAlign: void 0, 305 /** 306 * The y position offset of the label relative to the point in 307 * pixels. 308 * 309 * @type {number} 310 */ 311 y: void 0 312 }, 313 // False doesn't work well: https://jsfiddle.net/highcharts/hz8fopan/14/ 314 /** @ignore-option */ 315 startFromThreshold: true, 316 stickyTracking: false, 317 tooltip: { 318 distance: 6 319 }, 320 /** 321 * The Y axis value to serve as the base for the columns, for 322 * distinguishing between values above and below a threshold. If `null`, 323 * the columns extend from the padding Y axis minimum. 324 * 325 * @type {number|null} 326 * @since 2.0 327 * @product highcharts 328 */ 329 threshold: 0, 330 /** 331 * The width of the border surrounding each column or bar. Defaults to 332 * `1` when there is room for a border, but to `0` when the columns are 333 * so dense that a border would cover the next column. 334 *
335 * In styled mode, the stroke width can be set with the 336 * `.highcharts-point` rule. 337 * 338 * @sample {highcharts} highcharts/plotoptions/column-borderwidth/ 339 * 2px black border 340 * 341 * @type {number} 342 * @default undefined 343 * @product highcharts highstock gantt 344 * @apioption plotOptions.column.borderWidth 345 */ 346 /** 347 * The color of the border surrounding each column or bar. 348 * 349 * In styled mode, the border stroke can be set with the 350 * `.highcharts-point` rule. 351 * 352 * @sample {highcharts} highcharts/plotoptions/column-bordercolor/ 353 * Dark gray border 354 * 355 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 356 * @default #ffffff 357 * @product highcharts highstock gantt 358 */ 359 borderColor: "#ffffff" /* Palette.backgroundColor */ 360}; 361/** 362 * A `column` series. If the [type](#series.column.type) option is 363 * not specified, it is inherited from [chart.type](#chart.type). 364 * 365 * @extends series,plotOptions.column 366 * @excluding connectNulls, dataParser, dataURL, gapSize, gapUnit, linecap, 367 * lineWidth, marker, connectEnds, step 368 * @product highcharts highstock 369 * @apioption series.column 370 */ 371/** 372 * An array of data points for the series. For the `column` series type, 373 * points can be given in the following ways: 374 * 375 * 1. An array of numerical values. In this case, the numerical values will be 376 * interpreted as `y` options. The `x` values will be automatically 377 * calculated, either starting at 0 and incremented by 1, or from 378 * `pointStart` and `pointInterval` given in the series options. If the axis 379 * has categories, these will be used. Example: 380 * ```js 381 * data: [0, 5, 3, 5] 382 * ``` 383 * 384 * 2. An array of arrays with 2 values. In this case, the values correspond to 385 * `x,y`. If the first value is a string, it is applied as the name of the 386 * point, and the `x` value is inferred. 387 * ```js 388 * data: [ 389 * [0, 6], 390 * [1, 2], 391 * [2, 6] 392 * ] 393 * ``` 394 * 395 * 3. An array of objects with named values. The following snippet shows only a 396 * few settings, see the complete options set below. If the total number of 397 * data points exceeds the series' 398 * [turboThreshold](#series.column.turboThreshold), this option is not 399 * available. 400 * ```js 401 * data: [{ 402 * x: 1, 403 * y: 9, 404 * name: "Point2", 405 * color: "#00FF00" 406 * }, { 407 * x: 1, 408 * y: 6, 409 * name: "Point1", 410 * color: "#FF00FF" 411 * }] 412 * ``` 413 * 414 * @sample {highcharts} highcharts/chart/reflow-true/ 415 * Numerical values 416 * @sample {highcharts} highcharts/series/data-array-of-arrays/ 417 * Arrays of numeric x and y 418 * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/ 419 * Arrays of datetime x and y 420 * @sample {highcharts} highcharts/series/data-array-of-name-value/ 421 * Arrays of point.name and y 422 * @sample {highcharts} highcharts/series/data-array-of-objects/ 423 * Config objects 424 * 425 * @type {Array<number|Array<(number|string),(number|null)>|null|*>} 426 * @extends series.line.data 427 * @excluding marker 428 * @product highcharts highstock 429 * @apioption series.column.data 430 */ 431/** 432 * The color of the border surrounding the column or bar. 433 * 434 * In styled mode, the border stroke can be set with the `.highcharts-point` 435 * rule. 436 * 437 * @sample {highcharts} highcharts/plotoptions/column-bordercolor/ 438 * Dark gray border 439 * 440 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 441 * @product highcharts highstock 442 * @apioption series.column.data.borderColor 443 */ 444/** 445 * The width of the border surrounding the column or bar. 446 * 447 * In styled mode, the stroke width can be set with the `.highcharts-point` 448 * rule. 449 * 450 * @sample {highcharts} highcharts/plotoptions/column-borderwidth/ 451 * 2px black border 452 * 453 * @type {number} 454 * @product highcharts highstock 455 * @apioption series.column.data.borderWidth 456 */ 457/** 458 * A name for the dash style to use for the column or bar. Overrides 459 * dashStyle on the series. 460 * 461 * In styled mode, the stroke dash-array can be set with the same classes as 462 * listed under [data.color](#series.column.data.color). 463 * 464 * @see [series.pointWidth](#plotOptions.column.dashStyle) 465 * 466 * @type {Highcharts.DashStyleValue} 467 * @apioption series.column.data.dashStyle 468 */ 469/** 470 * A pixel value specifying a fixed width for the column or bar. Overrides 471 * pointWidth on the series. The width effects the dimension that is not based 472 * on the point value. 473 * 474 * @see [series.pointWidth](#plotOptions.column.pointWidth) 475 * 476 * @type {number} 477 * @apioption series.column.data.pointWidth 478 */ 479/** 480 * @excluding halo, lineWidth, lineWidthPlus, marker 481 * @product highcharts highstock 482 * @apioption series.column.states.hover 483 */ 484/** 485 * @excluding halo, lineWidth, lineWidthPlus, marker 486 * @product highcharts highstock 487 * @apioption series.column.states.select 488 */ 489''; // Keeps doclets above in JS file 490/* * 491 * 492 * Default Export 493 * 494 * */ 495export default ColumnSeriesDefaults;
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.