{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://westcoastcharts.dev/schema/1.1.5/wcc-options.schema.json", "title": "West Coast Charts options", "description": "The options object of new WestCoastCharts(el, options), generated from types/*.d.ts. Functions are marked \"x-wcc-type\": \"function\" (not expressible in JSON). Premium chart types and their plotOptions need west-coast-charts/premium (\"x-wcc-license\": \"premium\").", "x-wcc-version": "1.1.5", "type": "object", "properties": { "annotations": { "$ref": "#/$defs/ApexAnnotations", "description": "Lines, ranges, points, texts and images drawn on top of the plot at data coordinates." }, "chart": { "type": "object", "properties": { "licenseKey": { "type": "string", "description": "West Coast Charts premium: licence key of this chart (overrides WestCoastCharts.setLicenseKey)" }, "readability": { "anyOf": [ { "type": "string", "enum": [ "none", "halo", "pill", "auto", "hide" ] }, { "type": "boolean" }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "none", "halo", "pill", "auto", "hide" ], "description": "'auto' (default where on): nothing for labels off the marks, a contrasting text colour over one fill, a pill over mixed fills; 'hide' = skip labels that sit on marks" }, "fallback": { "type": "string", "enum": [ "halo", "pill", "hide" ], "description": "what 'auto' escalates to over mixed fills or when no text colour reaches minRatio. Default 'pill'" }, "enabled": { "type": "boolean", "description": "false switches the treatment off for this label kind" }, "contrast": { "type": "boolean", "description": "swap the text to `light`/`dark` when it misses minRatio against what is under it (any mode)" }, "minRatio": { "type": "number", "description": "WCAG 2 contrast ratio to reach. Default 4.5" }, "light": { "type": "string", "description": "text/backdrop colour pair used by contrast and 'auto' fills. Defaults '#ffffff' / '#111827'" }, "dark": { "type": "string", "description": "Dark colour of the pair. Default: `'#111827'`.", "default": "#111827" }, "background": { "type": "string", "description": "colour under the chart; 'auto' = chart.background, else the first opaque ancestor" }, "halo": { "type": "object", "properties": { "width": { "type": "number", "description": "Outline width in pixels. Default: `3`.", "default": 3 }, "color": { "type": "string", "description": "Outline colour; 'auto' uses the colour under the label or a contrasting one. Default: `'auto'`.", "default": "auto" }, "opacity": { "type": "number", "description": "Outline opacity (0 to 1). Default: `0.92`.", "default": 0.92 }, "blur": { "type": "number", "description": "Blur in pixels; above 0 the outline becomes a soft glow. Default: `0`.", "default": 0 } }, "additionalProperties": false, "description": "outline behind the glyphs; blur > 0 makes it a soft glow. Defaults width 3, color 'auto' (chart background), opacity 0.92" }, "pill": { "type": "object", "properties": { "fill": { "type": "string", "description": "Box colour; 'auto' uses the colour under the label or a contrasting one. Default: `'auto'`.", "default": "auto" }, "opacity": { "type": "number", "description": "Box opacity (0 to 1). Default: `0.9`.", "default": 0.9 }, "radius": { "type": "number", "description": "Corner radius in pixels. Default: `4`.", "default": 4 }, "padding": { "anyOf": [ { "type": "number" }, { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ], "minItems": 2, "maxItems": 2 } ], "description": "Space around the text in pixels: one number, or [vertical, horizontal]. Default: `[1, 4]`.", "default": [ 1, 4 ] }, "stroke": { "type": "string", "description": "Outline colour of the box. Default: `'none'`.", "default": "none" }, "strokeWidth": { "type": "number", "description": "Outline width in pixels. Default: `1`.", "default": 1 }, "offset": { "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ], "minItems": 2, "maxItems": 2, "description": "Shift of the box as [dx, dy] in pixels. Default: `[0, 0]`.", "default": [ 0, 0 ] } }, "additionalProperties": false, "description": "backdrop box. padding = [vertical, horizontal]; offset = [dx, dy] px. Defaults fill 'auto', opacity 0.9, radius 4, padding [1, 4]" }, "shadow": { "anyOf": [ { "type": "boolean" }, { "type": "object", "properties": { "dx": { "type": "number", "description": "Horizontal shadow offset in pixels. Default: `0`.", "default": 0 }, "dy": { "type": "number", "description": "Vertical shadow offset in pixels. Default: `1`.", "default": 1 }, "blur": { "type": "number", "description": "Shadow blur in pixels. Default: `2`.", "default": 2 }, "color": { "type": "string", "description": "Shadow colour. Default: `'#000000'`.", "default": "#000000" }, "opacity": { "type": "number", "description": "Shadow opacity (0 to 1). Default: `0.35`.", "default": 0.35 } }, "additionalProperties": false } ], "description": "drop shadow on the pill (on the text in halo mode)" }, "raise": { "type": "boolean", "description": "axis labels sitting on marks are moved above the series (default true)" }, "each": { "x-wcc-type": "function", "description": "per label: return an override (or 'none') for this one label; called only when set" } }, "additionalProperties": false } ], "description": "West Coast Charts: default readability of every label kind (dataLabels, axis labels, premium scales)" }, "accessibility": { "$ref": "#/$defs/WccChartAccessibility", "description": "West Coast Charts: WCAG 2.2 AA features (all on by default)" }, "width": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Chart width: a number is pixels, a string is any CSS length such as a percentage of the\ncontainer. Default: `'100%'`.", "default": "100%" }, "height": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Chart height: a number is pixels, a percentage is relative to the container's height; 'auto'\nuses the width divided by 1.61 for axis charts and by 1.2 for the others. Default: `'auto'`.", "default": "auto" }, "type": { "type": "string", "enum": [ "line", "area", "bar", "pie", "donut", "radialBar", "scatter", "bubble", "heatmap", "candlestick", "boxPlot", "radar", "polarArea", "rangeBar", "rangeArea", "treemap", "gauge", "funnel", "pyramid", "waterfall", "dumbbell", "beeswarm", "histogram", "violin", "raincloud", "sunburst", "icicle", "streamgraph", "unit", "waffle", "slope", "barRace", "calendar", "sankey", "chord", "gantt", "tree", "stock", "map", "marimekko", "network", "radialColumn", "quintTimeline", "quintConvergence", "vitalsClock", "schedule" ], "description": "The chart type. The West Coast Charts types (gauge ... calendar) need 'west-coast-charts/types'\n(included in 'west-coast-charts/full'), the premium types (sankey ... radialColumn) need\n'west-coast-charts/premium'." }, "foreColor": { "type": "string", "description": "Text colour used for axis labels, titles and legend text unless their own colour option is set.\nDefault: `'#373d3f'`.", "default": "#373d3f" }, "fontFamily": { "type": "string", "description": "Font family applied to all chart text that has no own fontFamily. Default: `'Helvetica, Arial,\nsans-serif'`.", "x-wcc-default": "'Helvetica, Arial,\nsans-serif'" }, "background": { "type": "string", "description": "Background colour of the chart area; an empty string leaves it transparent. Default: `''`.", "default": "" }, "offsetX": { "type": "number", "description": "Moves the whole drawing horizontally by this many pixels. Default: `0`.", "default": 0 }, "offsetY": { "type": "number", "description": "Moves the whole drawing vertically by this many pixels. Default: `0`.", "default": 0 }, "dropShadow": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Draws the shadow. Default: `false`.", "default": false }, "top": { "type": "number", "description": "Vertical shadow distance in pixels. Default: `2`.", "default": 2 }, "left": { "type": "number", "description": "Horizontal shadow distance in pixels. Default: `2`.", "default": 2 }, "blur": { "type": "number", "description": "Blur radius in pixels. Default: `4`.", "default": 4 }, "opacity": { "type": "number", "description": "Shadow opacity (0 to 1). Default: `0.7`.", "default": 0.7 }, "color": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "toString": { "x-wcc-type": "function", "description": "Returns a string representation of a string.\nReturns a string representation of an array." }, "charAt": { "x-wcc-type": "function", "description": "Returns the character at the specified index." }, "charCodeAt": { "x-wcc-type": "function", "description": "Returns the Unicode value of the character at the specified location." }, "concat": { "x-wcc-type": "function", "description": "Returns a string that contains the concatenation of two or more strings.\nCombines two or more arrays.\nThis method returns a new array without modifying any existing arrays." }, "indexOf": { "x-wcc-type": "function", "description": "Returns the position of the first occurrence of a substring.\nReturns the index of the first occurrence of a value in an array, or -1 if it is not present." }, "lastIndexOf": { "x-wcc-type": "function", "description": "Returns the last occurrence of a substring in the string.\nReturns the index of the last occurrence of a specified value in an array, or -1 if it is not present." }, "localeCompare": { "x-wcc-type": "function", "description": "Determines whether two strings are equivalent in the current locale.\nDetermines whether two strings are equivalent in the current or specified locale." }, "match": { "x-wcc-type": "function", "description": "Matches a string with a regular expression, and returns an array containing the results of that search.\nMatches a string or an object that supports being matched against, and returns an array\ncontaining the results of that search, or null if no matches are found." }, "replace": { "x-wcc-type": "function", "description": "Replaces text in a string, using a regular expression or search string.\nPasses a string and {@linkcode replaceValue} to the `[Symbol.replace]` method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm.\nReplaces text in a string, using an object that supports replacement within a string." }, "search": { "x-wcc-type": "function", "description": "Finds the first substring match in a regular expression search." }, "slice": { "x-wcc-type": "function", "description": "Returns a section of a string.\nReturns a copy of a section of an array.\nFor both start and end, a negative index can be used to indicate an offset from the end of the array.\nFor example, -2 refers to the second to last element of the array." }, "split": { "x-wcc-type": "function", "description": "Split a string into substrings using the specified separator and return them as an array." }, "substring": { "x-wcc-type": "function", "description": "Returns the substring at the specified location within a String object." }, "toLowerCase": { "x-wcc-type": "function", "description": "Converts all the alphabetic characters in a string to lowercase." }, "toLocaleLowerCase": { "x-wcc-type": "function", "description": "Converts all alphabetic characters to lowercase, taking into account the host environment's current locale." }, "toUpperCase": { "x-wcc-type": "function", "description": "Converts all the alphabetic characters in a string to uppercase." }, "toLocaleUpperCase": { "x-wcc-type": "function", "description": "Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale." }, "trim": { "x-wcc-type": "function", "description": "Removes the leading and trailing white space and line terminator characters from a string." }, "length": { "type": "number", "description": "Returns the length of a String object.\nGets or sets the length of the array. This is a number one higher than the highest index in the array." }, "substr": { "x-wcc-type": "function", "description": "Gets a substring beginning at the specified location and having the specified length.", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "valueOf": { "x-wcc-type": "function", "description": "Returns the primitive value of the specified object." }, "codePointAt": { "x-wcc-type": "function", "description": "Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point\nvalue of the UTF-16 encoded code point starting at the string element at position pos in\nthe String resulting from converting this object to a String.\nIf there is no element at that position, the result is undefined.\nIf a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos." }, "includes": { "x-wcc-type": "function", "description": "Returns true if searchString appears as a substring of the result of converting this\nobject to a String, at one or more positions that are\ngreater than or equal to position; otherwise, returns false.\nDetermines whether an array includes a certain element, returning true or false as appropriate." }, "endsWith": { "x-wcc-type": "function", "description": "Returns true if the sequence of elements of searchString converted to a String is the\nsame as the corresponding elements of this object (converted to a String) starting at\nendPosition – length(this). Otherwise returns false." }, "normalize": { "x-wcc-type": "function", "description": "Returns the String value result of normalizing the string into the normalization form\nnamed by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms." }, "repeat": { "x-wcc-type": "function", "description": "Returns a String value that is made from count copies appended together. If count is 0,\nthe empty string is returned." }, "startsWith": { "x-wcc-type": "function", "description": "Returns true if the sequence of elements of searchString converted to a String is the\nsame as the corresponding elements of this object (converted to a String) starting at\nposition. Otherwise returns false." }, "anchor": { "x-wcc-type": "function", "description": "Returns an `` HTML anchor element and sets the name attribute to the text value", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "big": { "x-wcc-type": "function", "description": "Returns a `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "blink": { "x-wcc-type": "function", "description": "Returns a `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "bold": { "x-wcc-type": "function", "description": "Returns a `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "fixed": { "x-wcc-type": "function", "description": "Returns a `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "fontcolor": { "x-wcc-type": "function", "description": "Returns a `` HTML element and sets the color attribute value", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "fontsize": { "x-wcc-type": "function", "description": "Returns a `` HTML element and sets the size attribute value", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "italics": { "x-wcc-type": "function", "description": "Returns an `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "link": { "x-wcc-type": "function", "description": "Returns an `` HTML element and sets the href attribute value", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "small": { "x-wcc-type": "function", "description": "Returns a `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "strike": { "x-wcc-type": "function", "description": "Returns a `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "sub": { "x-wcc-type": "function", "description": "Returns a `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "sup": { "x-wcc-type": "function", "description": "Returns a `` HTML element", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility" }, "padStart": { "x-wcc-type": "function", "description": "Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.\nThe padding is applied from the start (left) of the current string." }, "padEnd": { "x-wcc-type": "function", "description": "Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.\nThe padding is applied from the end (right) of the current string." }, "trimEnd": { "x-wcc-type": "function", "description": "Removes the trailing white space and line terminator characters from a string." }, "trimStart": { "x-wcc-type": "function", "description": "Removes the leading white space and line terminator characters from a string." }, "trimLeft": { "x-wcc-type": "function", "description": "Removes the leading white space and line terminator characters from a string.", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility. Use `trimStart` instead" }, "trimRight": { "x-wcc-type": "function", "description": "Removes the trailing white space and line terminator characters from a string.", "deprecated": true, "x-wcc-deprecated": "A legacy feature for browser compatibility. Use `trimEnd` instead" }, "matchAll": { "x-wcc-type": "function", "description": "Matches a string with a regular expression, and returns an iterable of matches\ncontaining the results of that search." }, "__@iterator@227": { "x-wcc-type": "function", "description": "Iterator" }, "toLocaleString": { "x-wcc-type": "function", "description": "Returns a date converted to a string using the current locale.\nReturns a string representation of an array. The elements are converted to string using their toLocaleString methods." }, "pop": { "x-wcc-type": "function", "description": "Removes the last element from an array and returns it.\nIf the array is empty, undefined is returned and the array is not modified." }, "push": { "x-wcc-type": "function", "description": "Appends new elements to the end of an array, and returns the new length of the array." }, "join": { "x-wcc-type": "function", "description": "Adds all the elements of an array into a string, separated by the specified separator string." }, "reverse": { "x-wcc-type": "function", "description": "Reverses the elements in an array in place.\nThis method mutates the array and returns a reference to the same array." }, "shift": { "x-wcc-type": "function", "description": "Removes the first element from an array and returns it.\nIf the array is empty, undefined is returned and the array is not modified." }, "sort": { "x-wcc-type": "function", "description": "Sorts an array in place.\nThis method mutates the array and returns a reference to the same array." }, "splice": { "x-wcc-type": "function", "description": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements." }, "unshift": { "x-wcc-type": "function", "description": "Inserts new elements at the start of an array, and returns the new length of the array." }, "every": { "x-wcc-type": "function", "description": "Determines whether all the members of an array satisfy the specified test." }, "some": { "x-wcc-type": "function", "description": "Determines whether the specified callback function returns true for any element of an array." }, "forEach": { "x-wcc-type": "function", "description": "Performs the specified action for each element in an array." }, "map": { "x-wcc-type": "function", "description": "Calls a defined callback function on each element of an array, and returns an array that contains the results." }, "filter": { "x-wcc-type": "function", "description": "Returns the elements of an array that meet the condition specified in a callback function." }, "reduce": { "x-wcc-type": "function", "description": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function." }, "reduceRight": { "x-wcc-type": "function", "description": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function." }, "find": { "x-wcc-type": "function", "description": "Returns the value of the first element in the array where predicate is true, and undefined\notherwise." }, "findIndex": { "x-wcc-type": "function", "description": "Returns the index of the first element in the array where predicate is true, and -1\notherwise." }, "fill": { "x-wcc-type": "function", "description": "Changes all array elements from `start` to `end` index to a static `value` and returns the modified array" }, "copyWithin": { "x-wcc-type": "function", "description": "Returns the this object after copying a section of the array identified by start and end\nto the same array starting at position target" }, "entries": { "x-wcc-type": "function", "description": "Returns an iterable of key, value pairs for every entry in the array" }, "keys": { "x-wcc-type": "function", "description": "Returns an iterable of keys in the array" }, "values": { "x-wcc-type": "function", "description": "Returns an iterable of values in the array" }, "flatMap": { "x-wcc-type": "function", "description": "Calls a defined callback function on each element of an array. Then, flattens the result into\na new array.\nThis is identical to a map followed by flat with depth 1." }, "flat": { "x-wcc-type": "function", "description": "Returns a new array with all sub-array elements concatenated into it recursively up to the\nspecified depth." }, "__@unscopables@230": { "x-wcc-type": "__type", "description": "Is an object whose properties have the value 'true'\nwhen they will be absent when used in a 'with' statement." } }, "required": [ "toString", "concat", "indexOf", "lastIndexOf", "slice", "length", "valueOf", "includes", "__@iterator@227", "toLocaleString", "__@unscopables@230" ], "additionalProperties": { "type": "string" } } ], "description": "Shadow colour. Default: `'#000'`.\nShadow colour; an array gives one colour per series. Default: `'#000'`.", "default": "#000" }, "enabledOnSeries": { "type": "array", "items": { "type": "number" }, "description": "Indexes of the series that get the shadow; not set means all series." } }, "additionalProperties": false, "description": "Shadow drawn behind series paths (lines, areas, bars)." }, "nonce": { "type": "string", "description": "CSP nonce copied onto every `