{ "AgAngleAxisFormattableLabelOptions": { "kind": "interface", "name": "AgAngleAxisFormattableLabelOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Label orientation.", "`fixed` - all labels remain in a fixed orientation of horizontal text.", "`parallel` - labels are in a circle around the axis.", "`perpendicular` - labels are in the radial direction perpendicular to the axis." ], "name": "orientation", "type": "AgAngleAxisLabelOrientation", "optional": true, "defaultValue": "fixed" } ] }, "AgAngleAxisLabelOptions": { "kind": "interface", "name": "AgAngleAxisLabelOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Label orientation.", "`fixed` - all labels remain in a fixed orientation of horizontal text.", "`parallel` - labels are in a circle around the axis.", "`perpendicular` - labels are in the radial direction perpendicular to the axis." ], "name": "orientation", "type": "AgAngleAxisLabelOrientation", "optional": true, "defaultValue": "fixed" } ] }, "AgAngleAxisLabelOrientation": { "kind": "typeAlias", "name": "AgAngleAxisLabelOrientation", "type": { "kind": "union", "type": [ "'fixed'", "'parallel'", "'perpendicular'" ] } }, "AgAngleCategoryAxisOptions": { "kind": "interface", "name": "AgAngleCategoryAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'angle-category'", "optional": false }, { "kind": "member", "docs": [ "Shape of axis. Default: `polygon`" ], "name": "shape", "type": "AgPolarAxisShape", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees to start ticks positioning from." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees to end ticks positioning at." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgAngleCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a angle category axis. It is a proportion between 0 and 1 which determines the size of the gap between the items within a single group along the angle axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a angle category axis. It is a proportion between 0 and 1 which determines the size of the gap between the groups of items along the angle axis." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true } ], "genericsMap": { "LabelType": "AgAngleAxisLabelOptions" } }, "AgAngleCategoryAxisThemeOptions": { "kind": "interface", "name": "AgAngleCategoryAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "Shape of axis. Default: `polygon`" ], "name": "shape", "type": "AgPolarAxisShape", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees to start ticks positioning from." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees to end ticks positioning at." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgAngleCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a angle category axis. It is a proportion between 0 and 1 which determines the size of the gap between the items within a single group along the angle axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a angle category axis. It is a proportion between 0 and 1 which determines the size of the gap between the groups of items along the angle axis." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true } ], "genericsMap": { "LabelType": "AgAngleAxisLabelOptions" } }, "AgAngleCrossLineOptions": { "kind": "interface", "name": "AgAngleCrossLineOptions", "members": [ { "kind": "member", "docs": [ "Type of Cross Line to render, defaults to `line`." ], "name": "type", "type": { "kind": "union", "type": [ "'line'", "'range'" ] }, "optional": false }, { "kind": "member", "docs": [ "Whether to show the Cross Line." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The data value at which the line should be positioned. This property is used if the Cross Line type is `line`." ], "name": "value", "type": "AxisValue", "optional": true }, { "kind": "member", "docs": [ "The range of values from the data used to display lines at a desired chart region. This property is only used for Cross Line type `range`." ], "name": "range", "type": { "kind": "tuple", "type": [ "AxisValue", "AxisValue" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour to use for the fill of the range." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the range." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour of the stroke for the lines." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the lines." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Cross Line label." ], "name": "label", "type": "LabelType", "optional": true } ], "genericsMap": { "LabelType": "AgBaseCrossLineLabelOptions" } }, "AgAngleNumberAxisOptions": { "kind": "interface", "name": "AgAngleNumberAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'angle-number'", "optional": false }, { "kind": "member", "docs": [ "Angle in degrees to start ticks positioning from." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees to end ticks positioning at. It should be greater than `startAngle`." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgAngleCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true } ], "genericsMap": { "LabelType": "AgAngleAxisFormattableLabelOptions", "TDatum": "number", "TInterval": "number" } }, "AgAngleNumberAxisThemeOptions": { "kind": "interface", "name": "AgAngleNumberAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "Angle in degrees to start ticks positioning from." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees to end ticks positioning at. It should be greater than `startAngle`." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgAngleCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true } ], "genericsMap": { "LabelType": "AgAngleAxisFormattableLabelOptions", "TDatum": "number", "TInterval": "number" } }, "AgAnimationOptions": { "kind": "interface", "name": "AgAnimationOptions", "members": [ { "kind": "member", "docs": [ "Set to `true` to enable the animation module." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The total duration of the animation for each series on initial load and updates" ], "name": "duration", "type": "DurationMs", "optional": true } ] }, "AgAnnotation": { "kind": "typeAlias", "name": "AgAnnotation", "type": { "kind": "union", "type": [ "AgLineAnnotation", "AgHorizontalLineAnnotation", "AgVerticalLineAnnotation", "AgDisjointChannelAnnotation", "AgParallelChannelAnnotation", "AgFibonacciRetracementAnnotation", "AgFibonacciRetracementTrendBasedAnnotation", "AgCalloutAnnotation", "AgCommentAnnotation", "AgNoteAnnotation", "AgTextAnnotation", "AgArrowAnnotation", "AgArrowUpAnnotation", "AgArrowDownAnnotation", "AgDateRangeAnnotation", "AgPriceRangeAnnotation", "AgDatePriceRangeAnnotation" ] } }, "AgAnnotationAxesButtons": { "kind": "interface", "name": "AgAnnotationAxesButtons", "members": [ { "kind": "member", "docs": [ "Which axis should display the annotation buttons." ], "name": "axes", "type": { "kind": "union", "type": [ "'x'", "'y'", "'xy'" ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ] }, "AgAnnotationAxisLabel": { "kind": "interface", "name": "AgAnnotationAxisLabel", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to the axis label container." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "T" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "genericsMap": { "T": "AgAnnotationLabelFormatterParams" } }, "AgAnnotationHandle": { "kind": "interface", "name": "AgAnnotationHandle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgAnnotationHandleStyles": { "kind": "interface", "name": "AgAnnotationHandleStyles", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgAnnotationLabelFormatterParams": { "kind": "interface", "name": "AgAnnotationLabelFormatterParams", "members": [ { "kind": "member", "docs": [ "The default label value that would have been used without a formatter." ], "name": "value", "type": "any", "optional": false } ] }, "AgAnnotationLineStyleType": { "kind": "typeAlias", "name": "AgAnnotationLineStyleType", "type": { "kind": "union", "type": [ "'solid'", "'dashed'", "'dotted'" ] } }, "AgAnnotationOptionsToolbar": { "kind": "interface", "name": "AgAnnotationOptionsToolbar", "members": [ { "kind": "member", "name": "buttons", "type": { "kind": "array", "type": "AgAnnotationToolbarButton" }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ] }, "AgAnnotationOptionsToolbarButton": { "kind": "interface", "name": "AgAnnotationOptionsToolbarButton", "members": [ { "kind": "member", "name": "value", "type": "AgAnnotationOptionsToolbarButtonValue", "optional": false }, { "kind": "member", "docs": [ "Icon to display on the button." ], "name": "icon", "type": "AgIconName", "optional": true }, { "kind": "member", "docs": [ "Text label to display on the button." ], "name": "label", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Text label to announce in screen readers." ], "name": "ariaLabel", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Tooltip text to display on hover over the button." ], "name": "tooltip", "type": "string", "optional": true } ] }, "AgAnnotationOptionsToolbarButtonValue": { "kind": "typeAlias", "name": "AgAnnotationOptionsToolbarButtonValue", "type": { "kind": "union", "type": [ "'line-stroke-width'", "'line-style-type'", "'line-color'", "'fill-color'", "'text-color'", "'text-size'", "'delete'", "'settings'" ] } }, "AgAnnotationOptionsToolbarSwitch": { "kind": "interface", "name": "AgAnnotationOptionsToolbarSwitch", "members": [ { "kind": "member", "name": "value", "type": "AgAnnotationOptionsToolbarSwitchValue", "optional": false }, { "kind": "member", "docs": [ "Overrides for the switch-button when checked." ], "name": "checkedOverrides", "type": "ToolbarButton", "optional": true }, { "kind": "member", "docs": [ "Icon to display on the button." ], "name": "icon", "type": "AgIconName", "optional": true }, { "kind": "member", "docs": [ "Text label to display on the button." ], "name": "label", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Text label to announce in screen readers." ], "name": "ariaLabel", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Tooltip text to display on hover over the button." ], "name": "tooltip", "type": "string", "optional": true } ] }, "AgAnnotationOptionsToolbarSwitchValue": { "kind": "typeAlias", "name": "AgAnnotationOptionsToolbarSwitchValue", "type": "'lock'" }, "AgAnnotationPoint": { "kind": "interface", "name": "AgAnnotationPoint", "members": [ { "kind": "member", "docs": [ "The x-value of the point." ], "name": "x", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "The y-value of the point." ], "name": "y", "type": "number", "optional": false } ] }, "AgAnnotationToolbarButton": { "kind": "typeAlias", "name": "AgAnnotationToolbarButton", "type": { "kind": "union", "type": [ "AgAnnotationOptionsToolbarButton", "AgAnnotationOptionsToolbarSwitch" ] } }, "AgAnnotationValue": { "kind": "typeAlias", "name": "AgAnnotationValue", "type": { "kind": "union", "type": [ "ValueType", "AgGroupingValueType" ] } }, "AgAnnotationsEvent": { "kind": "interface", "name": "AgAnnotationsEvent", "members": [ { "kind": "member", "name": "type", "type": "'annotations'", "optional": false }, { "kind": "member", "name": "annotations", "type": { "kind": "array", "type": "AgAnnotation" }, "optional": true } ] }, "AgAnnotationsOptions": { "kind": "interface", "name": "AgAnnotationsOptions", "members": [ { "kind": "member", "docs": [ "The options for the axes buttons" ], "name": "axesButtons", "type": "AgAnnotationAxesButtons", "optional": true }, { "kind": "member", "docs": [ "Configuration for the toolbar for creating annotations." ], "name": "toolbar", "type": "AgAnnotationsToolbar", "optional": true }, { "kind": "member", "docs": [ "Configuration for the options toolbar for editing an annotation." ], "name": "optionsToolbar", "type": "AgAnnotationOptionsToolbar", "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ] }, "AgAnnotationsThemeableOptions": { "kind": "interface", "name": "AgAnnotationsThemeableOptions", "members": [ { "kind": "member", "name": "line", "type": "AgLineAnnotationStyles", "optional": true }, { "kind": "member", "name": "'horizontal-line'", "type": "AgCrossLineAnnotationStyles", "optional": true }, { "kind": "member", "name": "'vertical-line'", "type": "AgCrossLineAnnotationStyles", "optional": true }, { "kind": "member", "name": "'disjoint-channel'", "type": "AgChannelAnnotationStyles", "optional": true }, { "kind": "member", "name": "'parallel-channel'", "type": "AgChannelAnnotationStyles", "optional": true }, { "kind": "member", "name": "'fibonacci-retracement'", "type": "AgFibonacciAnnotationStyles", "optional": true }, { "kind": "member", "name": "'fibonacci-retracement-trend-based'", "type": "AgFibonacciAnnotationStyles", "optional": true }, { "kind": "member", "name": "callout", "type": "AgCalloutAnnotationStyles", "optional": true }, { "kind": "member", "name": "comment", "type": "AgCommentAnnotationStyles", "optional": true }, { "kind": "member", "name": "note", "type": "AgNoteAnnotationStyles", "optional": true }, { "kind": "member", "name": "text", "type": "AgTextAnnotationStyles", "optional": true }, { "kind": "member", "name": "arrow", "type": "AgLineAnnotationStyles", "optional": true }, { "kind": "member", "name": "'arrow-up'", "type": "AgShapeAnnotationStyles", "optional": true }, { "kind": "member", "name": "'arrow-down'", "type": "AgShapeAnnotationStyles", "optional": true }, { "kind": "member", "name": "'date-range'", "type": "AgMeasurerAnnotationStyles", "optional": true }, { "kind": "member", "name": "'price-range'", "type": "AgMeasurerAnnotationStyles", "optional": true }, { "kind": "member", "name": "'date-price-range'", "type": "AgMeasurerAnnotationStyles", "optional": true }, { "kind": "member", "name": "'quick-date-price-range'", "type": "AgQuickMeasurerAnnotationStyles", "optional": true }, { "kind": "member", "docs": [ "The options for the axes buttons" ], "name": "axesButtons", "type": "AgAnnotationAxesButtons", "optional": true }, { "kind": "member", "docs": [ "Configuration for the toolbar for creating annotations." ], "name": "toolbar", "type": "AgAnnotationsToolbar", "optional": true }, { "kind": "member", "docs": [ "Configuration for the options toolbar for editing an annotation." ], "name": "optionsToolbar", "type": "AgAnnotationOptionsToolbar", "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ] }, "AgAnnotationsToolbar": { "kind": "interface", "name": "AgAnnotationsToolbar", "members": [ { "kind": "member", "name": "buttons", "type": { "kind": "array", "type": "AgAnnotationsToolbarButton" }, "optional": true }, { "kind": "member", "name": "padding", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ] }, "AgAnnotationsToolbarButton": { "kind": "interface", "name": "AgAnnotationsToolbarButton", "members": [ { "kind": "member", "name": "value", "type": "AgAnnotationsToolbarButtonValue", "optional": false }, { "kind": "member", "docs": [ "Icon to display on the button." ], "name": "icon", "type": "AgIconName", "optional": true }, { "kind": "member", "docs": [ "Text label to display on the button." ], "name": "label", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Text label to announce in screen readers." ], "name": "ariaLabel", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Tooltip text to display on hover over the button." ], "name": "tooltip", "type": "string", "optional": true } ] }, "AgAnnotationsToolbarButtonValue": { "kind": "typeAlias", "name": "AgAnnotationsToolbarButtonValue", "type": { "kind": "union", "type": [ "'line-menu'", "'fibonacci-menu'", "'text-menu'", "'shape-menu'", "'measurer-menu'", "'line'", "'horizontal-line'", "'vertical-line'", "'parallel-channel'", "'disjoint-channel'", "'fibonacci-retracement'", "'fibonacci-retracement-trend-based'", "'text'", "'comment'", "'callout'", "'note'", "'clear'" ] } }, "AgAreaMiniChartSeriesOptions": { "kind": "interface", "name": "AgAreaMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Area Series." ], "name": "type", "type": "'area'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The number to normalise the area stacks to. For example, if `normalizedTo` is set to `100`, the stacks will all be scaled proportionally so that their total height is always 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the areas should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgAreaSeriesMarkerItemStylerParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgAreaSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgAreaSeriesLabelFormatterParams": { "name": "AgAreaSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true } ] }, "AgAreaSeriesMarkerItemStylerParams": { "kind": "interface", "name": "AgAreaSeriesMarkerItemStylerParams", "members": [ { "kind": "member", "docs": [ "The x value of the datum." ], "name": "xValue", "type": "any", "optional": false }, { "kind": "member", "docs": [ "The y value of the datum." ], "name": "yValue", "type": "any", "optional": false }, { "kind": "member", "docs": [ "Whether the item's x value is the first in the data domain." ], "name": "first", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's x value is the last in the data domain." ], "name": "last", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's y value is the lowest in the data." ], "name": "min", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's y value is the highest in the data." ], "name": "max", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false } ] }, "AgAreaSeriesOptions": { "kind": "interface", "name": "AgAreaSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Area Series." ], "name": "type", "type": "'area'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The number to normalise the area stacks to. For example, if `normalizedTo` is set to `100`, the stacks will all be scaled proportionally so that their total height is always 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the areas should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgAreaSeriesMarkerItemStylerParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgAreaSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgAreaSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgAreaSeriesOptionsKeys": { "kind": "interface", "name": "AgAreaSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "any" } }, "AgAreaSeriesOptionsNames": { "kind": "interface", "name": "AgAreaSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgAreaSeriesThemeOverrides": { "kind": "interface", "name": "AgAreaSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgAreaSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgAreaSeriesThemeableOptions": { "kind": "interface", "name": "AgAreaSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgAreaSeriesMarkerItemStylerParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgAreaSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgAreaSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgAreaSeriesTooltipRendererParams": { "kind": "interface", "name": "AgAreaSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "yKey as specified on series options." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgAreaSparklinePreset": { "kind": "interface", "name": "AgAreaSparklinePreset", "members": [ { "kind": "member", "docs": [ "Configuration for the Area Series." ], "name": "type", "type": "'area'", "optional": false }, { "kind": "member", "docs": [ "Context to use for tooltips." ], "name": "context", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Crosshair configurations." ], "name": "crosshair", "type": "AgSparklineCrosshairOptions", "optional": true }, { "kind": "member", "docs": [ "y-axis configurations." ], "name": "axis", "type": "AgSparklineAxisOptions", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Tooltip configuration." ], "name": "tooltip", "type": "AgSparklineTooltip", "optional": true }, { "kind": "member", "name": "xKey", "type": "string", "optional": true }, { "kind": "member", "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The number to normalise the area stacks to. For example, if `normalizedTo` is set to `100`, the stacks will all be scaled proportionally so that their total height is always 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgAreaSeriesMarkerItemStylerParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgAreaSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgArrowAnnotation": { "kind": "interface", "name": "AgArrowAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the arrow annotation." ], "name": "type", "type": "'arrow'", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgArrowDownAnnotation": { "kind": "interface", "name": "AgArrowDownAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the arrow down annotation." ], "name": "type", "type": "'arrow-down'", "optional": false }, { "kind": "member", "docs": [ "The x-value of the point." ], "name": "x", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "The y-value of the point." ], "name": "y", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Configuration for the arrow mark annotation." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgArrowMarkAnnotation": { "kind": "interface", "name": "AgArrowMarkAnnotation", "members": [ { "kind": "member", "docs": [ "The x-value of the point." ], "name": "x", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "The y-value of the point." ], "name": "y", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Configuration for the arrow mark annotation." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgArrowUpAnnotation": { "kind": "interface", "name": "AgArrowUpAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the arrow up annotation." ], "name": "type", "type": "'arrow-up'", "optional": false }, { "kind": "member", "docs": [ "The x-value of the point." ], "name": "x", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "The y-value of the point." ], "name": "y", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Configuration for the arrow mark annotation." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgAutoScaledAxes": { "kind": "typeAlias", "name": "AgAutoScaledAxes", "type": { "kind": "array", "type": "'y'" } }, "AgAxisBaseIntervalOptions": { "kind": "interface", "name": "AgAxisBaseIntervalOptions", "members": [ { "kind": "member", "docs": [ "Array of values in axis units for specified intervals along the axis. The values in this array must be compatible with the axis type." ], "name": "values", "type": { "kind": "array", "type": "any" }, "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between intervals." ], "name": "minSpacing", "type": "PixelSize", "optional": true } ] }, "AgAxisBaseTickOptions": { "kind": "interface", "name": "AgAxisBaseTickOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis ticks." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis ticks." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The length in pixels of the axis ticks." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis ticks." ], "name": "stroke", "type": "CssColor", "optional": true } ] }, "AgAxisBoundSeries": { "kind": "interface", "name": "AgAxisBoundSeries", "members": [ { "kind": "member", "docs": [ "Key used by the series for values on the related axis." ], "name": "key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Optional name used by the series for values on the related axis." ], "name": "name", "type": "string", "optional": true } ] }, "AgAxisCaptionFormatterParams": { "kind": "interface", "name": "AgAxisCaptionFormatterParams", "members": [ { "kind": "member", "docs": [ "Direction of the axis the title belongs to." ], "name": "direction", "type": { "kind": "union", "type": [ "'x'", "'y'" ] }, "optional": false }, { "kind": "member", "docs": [ "Metadata about series bound to the axis the title belongs to." ], "name": "boundSeries", "type": { "kind": "array", "type": "AgAxisBoundSeries" }, "optional": false }, { "kind": "member", "docs": [ "Computed domain of the axis" ], "name": "domain", "type": { "kind": "array", "type": "any" }, "optional": false }, { "kind": "member", "docs": [ "Default value to be used for the axis title (as specified in chart options or theme)." ], "name": "defaultValue", "type": "string", "optional": true } ] }, "AgAxisCaptionOptions": { "kind": "interface", "name": "AgAxisCaptionOptions", "members": [ { "kind": "member", "docs": [ "Whether the title should be shown." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The text to show in the title." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the title." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the title." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the title." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the title." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the title." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Spacing between the axis labels and the axis title." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Formatter to allow dynamic axis title calculation." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisCaptionFormatterParams" ] }, "optional": true } ] }, "AgAxisContinuousIntervalOptions": { "kind": "interface", "name": "AgAxisContinuousIntervalOptions", "members": [ { "kind": "member", "docs": [ "The axis interval. Expressed in the units of the axis. If the configured interval results in too many items given the chart size, it will be ignored." ], "name": "step", "type": "T", "optional": true }, { "kind": "member", "docs": [ "Maximum gap in pixels between items." ], "name": "maxSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Array of values in axis units for specified intervals along the axis. The values in this array must be compatible with the axis type." ], "name": "values", "type": { "kind": "array", "type": "any" }, "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between intervals." ], "name": "minSpacing", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": "TimeInterval | number", "default": null } ] }, "AgAxisGridLineOptions": { "kind": "interface", "name": "AgAxisGridLineOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis grid lines." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis grid lines." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration of the lines used to form the grid in the chart series area." ], "name": "style", "type": { "kind": "array", "type": "AgAxisGridStyle" }, "optional": true } ] }, "AgAxisGridStyle": { "kind": "interface", "name": "AgAxisGridStyle", "members": [ { "kind": "member", "docs": [ "The colour of the grid line." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Defines how the grid lines are rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true } ] }, "AgAxisLabelFormatterParams": { "kind": "interface", "name": "AgAxisLabelFormatterParams", "members": [ { "kind": "member", "name": "value", "type": "any", "optional": false }, { "kind": "member", "name": "index", "type": "number", "optional": false }, { "kind": "member", "name": "boundSeries", "type": { "kind": "array", "type": "AgAxisBoundSeries" }, "optional": false }, { "kind": "member", "name": "domain", "type": { "kind": "array", "type": "any" }, "optional": false }, { "kind": "member", "name": "fractionDigits", "type": "number", "optional": true } ] }, "AgAxisLabelStylerParams": { "kind": "interface", "name": "AgAxisLabelStylerParams", "members": [ { "kind": "member", "docs": [ "The label value that would be used, after applying formating." ], "name": "value", "type": "any", "optional": false }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgAxisLineOptions": { "kind": "interface", "name": "AgAxisLineOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis line." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis line." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis line." ], "name": "stroke", "type": "CssColor", "optional": true } ] }, "AgBarMiniChartSeriesOptions": { "kind": "interface", "name": "AgBarMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Bar Series." ], "name": "type", "type": "'bar'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Whether to group together (adjacently) separate bars." ], "name": "grouped", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the bars should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The number to normalise the bar stacks to. Has no effect when `grouped` is `true`. For example, if `normalizedTo` is set to `100`, the bar stacks will all be scaled proportionally so that each of their totals is 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Align bars to whole pixel values to remove anti-aliasing." ], "name": "crisp", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual bars, based on the given parameters. If the current bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgBarSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBarSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBarSeriesItemStylerParams": { "kind": "interface", "name": "AgBarSeriesItemStylerParams", "members": [ { "kind": "member", "docs": [ "The x value of the datum." ], "name": "xValue", "type": "any", "optional": false }, { "kind": "member", "docs": [ "The y value of the datum." ], "name": "yValue", "type": "any", "optional": false }, { "kind": "member", "docs": [ "Whether the item's x value is the first in the data domain." ], "name": "first", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's x value is the last in the data domain." ], "name": "last", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's y value is the lowest in the data." ], "name": "min", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's y value is the highest in the data." ], "name": "max", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "name": "stackGroup", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgBarSeriesLabelFormatterParams": { "name": "AgBarSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, a corresponding `yName` will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true } ] }, "AgBarSeriesLabelOptions": { "kind": "interface", "name": "AgBarSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Where to render series labels relative to the segments." ], "name": "placement", "type": "AgBarSeriesLabelPlacement", "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgBarSeriesLabelPlacement": { "kind": "typeAlias", "name": "AgBarSeriesLabelPlacement", "type": { "kind": "union", "type": [ "'inside-center'", "'inside-start'", "'inside-end'", "'outside-start'", "'outside-end'" ] } }, "AgBarSeriesOptions": { "kind": "interface", "name": "AgBarSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Bar Series." ], "name": "type", "type": "'bar'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Whether to group together (adjacently) separate bars." ], "name": "grouped", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the bars should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The number to normalise the bar stacks to. Has no effect when `grouped` is `true`. For example, if `normalizedTo` is set to `100`, the bar stacks will all be scaled proportionally so that each of their totals is 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the Error Bars." ], "name": "errorBar", "type": { "kind": "typeRef", "type": "AgErrorBarOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, a corresponding `yName` will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction.", "", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Align bars to whole pixel values to remove anti-aliasing." ], "name": "crisp", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on bars." ], "name": "label", "type": { "kind": "typeRef", "type": "AgBarSeriesLabelOptions", "typeArguments": [ "TDatum", "AgBarSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgBarSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual bars, based on the given parameters. If the current bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgBarSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBarSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBarSeriesOptionsKeys": { "kind": "interface", "name": "AgBarSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "any" } }, "AgBarSeriesOptionsNames": { "kind": "interface", "name": "AgBarSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, a corresponding `yName` will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBarSeriesStyle": { "kind": "interface", "name": "AgBarSeriesStyle", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBarSeriesThemeOverrides": { "kind": "interface", "name": "AgBarSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgBarSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBarSeriesThemeableOptions": { "kind": "interface", "name": "AgBarSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Bar rendering direction.", "", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Align bars to whole pixel values to remove anti-aliasing." ], "name": "crisp", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on bars." ], "name": "label", "type": { "kind": "typeRef", "type": "AgBarSeriesLabelOptions", "typeArguments": [ "TDatum", "AgBarSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgBarSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual bars, based on the given parameters. If the current bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgBarSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBarSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Error Bars." ], "name": "errorBar", "type": "AgErrorBarThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBarSeriesTooltipRendererParams": { "kind": "interface", "name": "AgBarSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, a corresponding `yName` will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the x axis data." ], "name": "xLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The x-axis lower bound error value." ], "name": "xLowerValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the x axis. This is the value to use in tooltips or labels." ], "name": "xLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the x axis data." ], "name": "xUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The x-axis upper bound error value." ], "name": "xUpperValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the x axis. This is the value to use in tooltips or labels." ], "name": "xUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the y axis data." ], "name": "yLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The y-axis lower bound error value." ], "name": "yLowerValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the y axis. This is the value to use in tooltips or labels." ], "name": "yLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the y axis data." ], "name": "yUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The y-axis upper bound error value." ], "name": "yUpperValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the y axis. This is the value to use in tooltips or labels." ], "name": "yUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgBarSparklinePreset": { "kind": "interface", "name": "AgBarSparklinePreset", "members": [ { "kind": "member", "docs": [ "Configuration for the Bar Series." ], "name": "type", "type": "'bar'", "optional": false }, { "kind": "member", "docs": [ "Context to use for tooltips." ], "name": "context", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Crosshair configurations." ], "name": "crosshair", "type": "AgSparklineCrosshairOptions", "optional": true }, { "kind": "member", "docs": [ "y-axis configurations." ], "name": "axis", "type": "AgSparklineAxisOptions", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Tooltip configuration." ], "name": "tooltip", "type": "AgSparklineTooltip", "optional": true }, { "kind": "member", "name": "xKey", "type": "string", "optional": true }, { "kind": "member", "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The number to normalise the bar stacks to. Has no effect when `grouped` is `true`. For example, if `normalizedTo` is set to `100`, the bar stacks will all be scaled proportionally so that each of their totals is 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, a corresponding `yName` will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction.", "", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Align bars to whole pixel values to remove anti-aliasing." ], "name": "crisp", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on bars." ], "name": "label", "type": { "kind": "typeRef", "type": "AgBarSeriesLabelOptions", "typeArguments": [ "TDatum", "AgBarSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual bars, based on the given parameters. If the current bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgBarSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBarSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseAxisFormattableLabelOptions": { "kind": "interface", "name": "AgBaseAxisFormattableLabelOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true } ] }, "AgBaseAxisLabelOptions": { "kind": "interface", "name": "AgBaseAxisLabelOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgBaseAxisLabelStyleOptions": { "kind": "interface", "name": "AgBaseAxisLabelStyleOptions", "members": [ { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgBaseAxisOptions": { "kind": "interface", "name": "AgBaseAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "LabelType", "constraint": null, "default": "any" } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel" } }, "AgBaseCartesianAxisLabelOptions": { "kind": "interface", "name": "AgBaseCartesianAxisLabelOptions", "members": [ { "kind": "member", "docs": [ "If specified and axis labels may collide, they are rotated so that they are positioned at the supplied angle. This is enabled by default for category. If the `rotation` property is specified, it takes precedence." ], "name": "autoRotate", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "If autoRotate is enabled, specifies the rotation angle to use when autoRotate is activated. Defaults to an angle of 335 degrees if unspecified." ], "name": "autoRotateAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgBaseCartesianAxisOptions": { "kind": "interface", "name": "AgBaseCartesianAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "string", "optional": false }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgCartesianCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "LabelType", "constraint": null, "default": "AgCartesianAxisLabelOptions" }, { "kind": "typeParam", "name": "CrosshairLabelType", "constraint": null, "default": "AgCrosshairLabel" } ], "docs": [ "Configuration for axes in cartesian charts." ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel" } }, "AgBaseCartesianChartOptions": { "kind": "interface", "name": "AgBaseCartesianChartOptions", "members": [ { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": { "kind": "array", "type": "AgCartesianAxisOptions" }, "optional": true }, { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgCartesianSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Annotations configurations." ], "name": "annotations", "type": "AgAnnotationsOptions", "optional": true } ] }, "AgBaseCartesianThemeOptions": { "kind": "interface", "name": "AgBaseCartesianThemeOptions", "members": [ { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseCartesianThemeableOptions": { "kind": "interface", "name": "AgBaseCartesianThemeableOptions", "members": [ { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "any" } }, "AgBaseChartListeners": { "kind": "interface", "name": "AgBaseChartListeners", "members": [ { "kind": "member", "docs": [ "The listener to call when a node (marker, column, bar, tile or a pie sector) in any series is clicked. Useful for a chart containing multiple series." ], "name": "seriesNodeClick", "type": { "kind": "typeRef", "type": "Listener", "typeArguments": [ { "kind": "typeRef", "type": "AgNodeClickEvent", "typeArguments": [ "'seriesNodeClick'", "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The listener to call when a node (marker, column, bar, tile or a pie sector) in any series is double-clicked. Useful for a chart containing multiple series." ], "name": "seriesNodeDoubleClick", "type": { "kind": "typeRef", "type": "Listener", "typeArguments": [ { "kind": "typeRef", "type": "AgNodeClickEvent", "typeArguments": [ "'seriesNodeDoubleClick'", "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The listener to call when a series visibility is changed." ], "name": "seriesVisibilityChange", "type": { "kind": "typeRef", "type": "Listener", "typeArguments": [ "AgSeriesVisibilityChange" ] }, "optional": true }, { "kind": "member", "docs": [ "The listener to call when the chart is clicked." ], "name": "click", "type": { "kind": "typeRef", "type": "Listener", "typeArguments": [ "AgChartClickEvent" ] }, "optional": true }, { "kind": "member", "docs": [ "The listener to call when the chart is double-clicked." ], "name": "doubleClick", "type": { "kind": "typeRef", "type": "Listener", "typeArguments": [ "AgChartDoubleClickEvent" ] }, "optional": true }, { "kind": "member", "docs": [ "The listener to call when the annotations are changed." ], "name": "annotations", "type": { "kind": "function", "params": [ { "kind": "param", "name": "event", "type": "AgAnnotationsEvent" } ], "returnType": "void" }, "optional": true }, { "kind": "member", "docs": [ "The listener to call when the zoom is changed." ], "name": "zoom", "type": { "kind": "typeRef", "type": "Listener", "typeArguments": [ "AgZoomEvent" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgBaseChartOptions": { "kind": "interface", "name": "AgBaseChartOptions", "members": [ { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "docs": [ "Configuration common to all charts." ], "genericsMap": { "TDatum": "any" } }, "AgBaseChartThemeOptions": { "kind": "interface", "name": "AgBaseChartThemeOptions", "members": [ { "kind": "member", "docs": [ "The palette to use. If specified, this replaces the palette from the base theme." ], "name": "palette", "type": "AgChartThemePalette", "optional": true }, { "kind": "member", "docs": [ "Global parameters to set styles across the whole chart." ], "name": "params", "type": "AgChartThemeParams", "optional": true }, { "kind": "member", "docs": [ "Configuration from this object is merged over the defaults specified in the base theme." ], "name": "overrides", "type": "AgThemeOverrides", "optional": true } ] }, "AgBaseChartThemeParams": { "kind": "interface", "name": "AgBaseChartThemeParams", "members": [ { "kind": "member", "docs": [ "The 'brand colour' for the chart, used wherever a non-neutral colour is required. Selections, focus outlines and checkboxes use the accent colour by default." ], "name": "accentColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Background colour of the chart. Most text, borders and backgrounds are defined as a blend between the background and foreground colors." ], "name": "backgroundColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Default colour for borders." ], "name": "borderColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Default colour for neutral UI elements. Most text, borders and backgrounds are defined as a blend between the background and foreground colors." ], "name": "foregroundColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Default font size used for all text. Titles and some other text are scaled to this font size." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "Background colour for text inputs." ], "name": "inputBackgroundColor", "type": "CssColor", "optional": true, "defaultValue": "backgroundColor" }, { "kind": "member", "docs": [ "Colour of text within text inputs." ], "name": "inputTextColor", "type": "CssColor", "optional": true, "defaultValue": "textColor" }, { "kind": "member", "docs": [ "Colour of text that should stand out less than the default." ], "name": "subtleTextColor", "type": "CssColor", "optional": true, "defaultValue": "foregroundColor + backgroundColor" }, { "kind": "member", "docs": [ "Default colour for all text." ], "name": "textColor", "type": "CssColor", "optional": true, "defaultValue": "foregroundColor" } ] }, "AgBaseCrossLineLabelOptions": { "kind": "interface", "name": "AgBaseCrossLineLabelOptions", "members": [ { "kind": "member", "docs": [ "Whether to show the Cross Line label." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The text to show in the label." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the label." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the label." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the label." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the label." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the label and the edge of the Cross Line." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the label." ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgBaseCrossLineOptions": { "kind": "interface", "name": "AgBaseCrossLineOptions", "members": [ { "kind": "member", "docs": [ "Type of Cross Line to render, defaults to `line`." ], "name": "type", "type": { "kind": "union", "type": [ "'line'", "'range'" ] }, "optional": false }, { "kind": "member", "docs": [ "Whether to show the Cross Line." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The data value at which the line should be positioned. This property is used if the Cross Line type is `line`." ], "name": "value", "type": "AxisValue", "optional": true }, { "kind": "member", "docs": [ "The range of values from the data used to display lines at a desired chart region. This property is only used for Cross Line type `range`." ], "name": "range", "type": { "kind": "tuple", "type": [ "AxisValue", "AxisValue" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour to use for the fill of the range." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the range." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour of the stroke for the lines." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the lines." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Cross Line label." ], "name": "label", "type": "LabelType", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "LabelType", "constraint": null, "default": "AgBaseCrossLineLabelOptions" } ], "genericsMap": { "LabelType": "AgRadiusCrossLineLabelOptions" } }, "AgBaseCrosshairLabel": { "kind": "interface", "name": "AgBaseCrosshairLabel", "members": [ { "kind": "member", "docs": [ "Whether to show label when the crosshair is visible." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The horizontal offset in pixels for the label." ], "name": "xOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The vertical offset in pixels for the label." ], "name": "yOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to create the content for the label." ], "name": "renderer", "type": { "kind": "typeRef", "type": "Renderer", "typeArguments": [ "AgCrosshairLabelRendererParams", "AgCrosshairLabelRendererResult" ] }, "optional": true } ] }, "AgBaseFinancialPresetOptions": { "name": "AgBaseFinancialPresetOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "A predefined theme name or an object containing theme overrides.", "", " See: [Themes Reference](/themes-api/)" ], "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseFlowProportionChartOptions": { "kind": "interface", "name": "AgBaseFlowProportionChartOptions", "members": [ { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgFlowProportionSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Nodes to use instead of inferring from data." ], "name": "nodes", "type": { "kind": "array", "type": "any" }, "optional": true } ] }, "AgBaseFlowProportionThemeOptions": { "kind": "interface", "name": "AgBaseFlowProportionThemeOptions", "members": [ { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseGaugePresetOptions": { "kind": "interface", "name": "AgBaseGaugePresetOptions", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseGaugePresetThemeOptions": { "name": "AgBaseGaugePresetThemeOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseGaugeThemeableOptions": { "kind": "interface", "name": "AgBaseGaugeThemeableOptions", "members": [ { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "GaugeDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseHierarchyChartOptions": { "kind": "interface", "name": "AgBaseHierarchyChartOptions", "members": [ { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgHierarchySeriesOptions" }, "optional": true } ] }, "AgBaseHierarchyThemeOptions": { "kind": "interface", "name": "AgBaseHierarchyThemeOptions", "members": [ { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBasePolarChartOptions": { "kind": "interface", "name": "AgBasePolarChartOptions", "members": [ { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgPolarSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": { "kind": "array", "type": "AgPolarAxisOptions" }, "optional": true } ] }, "AgBasePolarThemeOptions": { "kind": "interface", "name": "AgBasePolarThemeOptions", "members": [ { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgPolarAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseRadarSeriesOptions": { "kind": "interface", "name": "AgBaseRadarSeriesOptions", "members": [ { "kind": "member", "name": "type", "type": { "kind": "union", "type": [ "'radar-line'", "'radar-area'" ] }, "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgRadialSeriesOptionsKeys" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadarSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadarSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBaseRadialColumnSeriesOptions": { "kind": "interface", "name": "AgBaseRadialColumnSeriesOptions", "members": [ { "kind": "member", "docs": [ "Base configuration for Radial Column series." ], "name": "type", "type": { "kind": "union", "type": [ "'radial-column'", "'nightingale'" ] }, "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The number to normalise the bar stacks to. Has no effect unless series are stacked." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Whether to group together (adjacently) separate sectors." ], "name": "grouped", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the sectors should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadialSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the radial columns." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRadialSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBaseRadialSeriesThemeableOptions": { "kind": "interface", "name": "AgBaseRadialSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadialSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the radial columns." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRadialSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBaseSeriesOptions": { "kind": "interface", "name": "AgBaseSeriesOptions", "members": [ { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "any" } }, "AgBaseSeriesThemeableOptions": { "kind": "interface", "name": "AgBaseSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "any" } }, "AgBaseSparklinePresetOptions": { "kind": "interface", "name": "AgBaseSparklinePresetOptions", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Context to use for tooltips." ], "name": "context", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Crosshair configurations." ], "name": "crosshair", "type": "AgSparklineCrosshairOptions", "optional": true }, { "kind": "member", "docs": [ "y-axis configurations." ], "name": "axis", "type": "AgSparklineAxisOptions", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Tooltip configuration." ], "name": "tooltip", "type": "AgSparklineTooltip", "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseSparklinePresetThemeOptions": { "name": "AgBaseSparklinePresetThemeOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "Context to use for tooltips." ], "name": "context", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Crosshair configurations." ], "name": "crosshair", "type": "AgSparklineCrosshairOptions", "optional": true }, { "kind": "member", "docs": [ "y-axis configurations." ], "name": "axis", "type": "AgSparklineAxisOptions", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Tooltip configuration." ], "name": "tooltip", "type": "AgSparklineTooltip", "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseStandaloneChartOptions": { "kind": "interface", "name": "AgBaseStandaloneChartOptions", "members": [ { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgStandaloneSeriesOptions" }, "optional": true } ] }, "AgBaseStandaloneThemeOptions": { "kind": "interface", "name": "AgBaseStandaloneThemeOptions", "members": [ { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBaseThemeableChartOptions": { "kind": "interface", "name": "AgBaseThemeableChartOptions", "members": [ { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBaseTopologyChartOptions": { "kind": "interface", "name": "AgBaseTopologyChartOptions", "members": [ { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgTopologySeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Topology to use in all series." ], "name": "topology", "type": "GeoJSON", "optional": true } ] }, "AgBaseTopologyThemeOptions": { "kind": "interface", "name": "AgBaseTopologyThemeOptions", "members": [ { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBoxPlotCapOptions": { "kind": "interface", "name": "AgBoxPlotCapOptions", "members": [ { "kind": "member", "name": "lengthRatio", "type": "Ratio", "optional": true } ] }, "AgBoxPlotMiniChartSeriesOptions": { "kind": "interface", "name": "AgBoxPlotMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Box Plot Series." ], "name": "type", "type": "'box-plot'", "optional": false }, { "kind": "member", "docs": [ "The key used to retrieve x-values (categories) from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve minimum values from the data." ], "name": "minKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve lower quartile values from the data." ], "name": "q1Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve median values from the data." ], "name": "medianKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve upper quartile values from the data." ], "name": "q3Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve maximum values from the data." ], "name": "maxKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Whether to group together (adjacently) separate columns." ], "name": "grouped", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual columns, based on the given parameters. If the current column is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgBoxPlotSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBoxPlotSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's caps" ], "name": "cap", "type": "AgBoxPlotCapOptions", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's whiskers" ], "name": "whisker", "type": "AgBoxPlotWhiskerOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBoxPlotSeriesItemStylerParams": { "name": "AgBoxPlotSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key used to retrieve x-values (categories) from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve minimum values from the data." ], "name": "minKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve lower quartile values from the data." ], "name": "q1Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve median values from the data." ], "name": "medianKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve upper quartile values from the data." ], "name": "q3Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve maximum values from the data." ], "name": "maxKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "Options to style chart's caps" ], "name": "cap", "type": "AgBoxPlotCapOptions", "optional": false }, { "kind": "member", "docs": [ "Options to style chart's whiskers" ], "name": "whisker", "type": "AgBoxPlotWhiskerOptions", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false } ] }, "AgBoxPlotSeriesOptions": { "kind": "interface", "name": "AgBoxPlotSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Box Plot Series." ], "name": "type", "type": "'box-plot'", "optional": false }, { "kind": "member", "docs": [ "The key used to retrieve x-values (categories) from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve minimum values from the data." ], "name": "minKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve lower quartile values from the data." ], "name": "q1Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve median values from the data." ], "name": "medianKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve upper quartile values from the data." ], "name": "q3Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve maximum values from the data." ], "name": "maxKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Whether to group together (adjacently) separate columns." ], "name": "grouped", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction.", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgBoxPlotSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual columns, based on the given parameters. If the current column is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgBoxPlotSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBoxPlotSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's caps" ], "name": "cap", "type": "AgBoxPlotCapOptions", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's whiskers" ], "name": "whisker", "type": "AgBoxPlotWhiskerOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A descriptive label for x-values." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A descriptive label for y-values." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of minimum values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "minName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of lower quartile values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "q1Name", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of median values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "medianName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of upper quartile values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "q3Name", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of maximum values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "maxName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBoxPlotSeriesStyle": { "kind": "interface", "name": "AgBoxPlotSeriesStyle", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's caps" ], "name": "cap", "type": "AgBoxPlotCapOptions", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's whiskers" ], "name": "whisker", "type": "AgBoxPlotWhiskerOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgBoxPlotSeriesThemeOverrides": { "kind": "interface", "name": "AgBoxPlotSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgBoxPlotSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBoxPlotSeriesThemeableOptions": { "kind": "interface", "name": "AgBoxPlotSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Bar rendering direction.", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgBoxPlotSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual columns, based on the given parameters. If the current column is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgBoxPlotSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBoxPlotSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's caps" ], "name": "cap", "type": "AgBoxPlotCapOptions", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's whiskers" ], "name": "whisker", "type": "AgBoxPlotWhiskerOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBoxPlotSeriesTooltipRendererParams": { "kind": "interface", "name": "AgBoxPlotSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The key used to retrieve x-values (categories) from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve minimum values from the data." ], "name": "minKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve lower quartile values from the data." ], "name": "q1Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve median values from the data." ], "name": "medianKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve upper quartile values from the data." ], "name": "q3Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve maximum values from the data." ], "name": "maxKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A descriptive label for x-values." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A descriptive label for y-values." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of minimum values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "minName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of lower quartile values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "q1Name", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of median values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "medianName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of upper quartile values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "q3Name", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of maximum values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "maxName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's caps" ], "name": "cap", "type": "AgBoxPlotCapOptions", "optional": true }, { "kind": "member", "docs": [ "Options to style chart's whiskers" ], "name": "whisker", "type": "AgBoxPlotWhiskerOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgBoxPlotWhiskerOptions": { "name": "AgBoxPlotWhiskerOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgBubbleMiniChartSeriesOptions": { "kind": "interface", "name": "AgBubbleMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Bubble Series." ], "name": "type", "type": "'bubble'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Explicitly specifies the extent of the domain for series `sizeKey`." ], "name": "domain", "type": { "kind": "tuple", "type": [ "number", "number" ] }, "optional": true }, { "kind": "member", "docs": [ "Determines the smallest size a marker can be in pixels." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Determines the largest size a marker can be in pixels." ], "name": "maxSize", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "BubbleSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBubbleSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBubbleSeriesLabel": { "kind": "interface", "name": "AgBubbleSeriesLabel", "members": [ { "kind": "member", "docs": [ "Placement of label in relation to the marker." ], "name": "placement", "type": "LabelPlacement", "optional": true, "defaultValue": "top" }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TParams": "AgBubbleSeriesLabelFormatterParams" } }, "AgBubbleSeriesLabelFormatterParams": { "name": "AgBubbleSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ] }, "AgBubbleSeriesOptions": { "kind": "interface", "name": "AgBubbleSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Bubble Series." ], "name": "type", "type": "'bubble'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Explicitly specifies the extent of the domain for series `sizeKey`." ], "name": "domain", "type": { "kind": "tuple", "type": [ "number", "number" ] }, "optional": true }, { "kind": "member", "docs": [ "Determines the smallest size a marker can be in pixels." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Determines the largest size a marker can be in pixels." ], "name": "maxSize", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgBubbleSeriesLabel", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgBubbleSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "BubbleSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBubbleSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBubbleSeriesOptionsKeys": { "kind": "interface", "name": "AgBubbleSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgBubbleSeriesOptionsNames": { "kind": "interface", "name": "AgBubbleSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgBubbleSeriesStyle": { "kind": "interface", "name": "AgBubbleSeriesStyle", "members": [ { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBubbleSeriesThemeOverrides": { "kind": "interface", "name": "AgBubbleSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgBubbleSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgBubbleSeriesThemeableOptions": { "kind": "interface", "name": "AgBubbleSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Explicitly specifies the extent of the domain for series `sizeKey`." ], "name": "domain", "type": { "kind": "tuple", "type": [ "number", "number" ] }, "optional": true }, { "kind": "member", "docs": [ "Determines the smallest size a marker can be in pixels." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Determines the largest size a marker can be in pixels." ], "name": "maxSize", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgBubbleSeriesLabel", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgBubbleSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "BubbleSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgBubbleSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgBubbleSeriesTooltipRendererParams": { "kind": "interface", "name": "AgBubbleSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgCalloutAnnotation": { "kind": "interface", "name": "AgCalloutAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the callout annotation." ], "name": "type", "type": "'callout'", "optional": false }, { "kind": "member", "docs": [ "The starting point of the annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of the annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The text content." ], "name": "text", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgCalloutAnnotationStyles": { "kind": "interface", "name": "AgCalloutAnnotationStyles", "members": [ { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgCandlestickMiniChartSeriesOptions": { "kind": "interface", "name": "AgCandlestickMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Candlestick Series." ], "name": "type", "type": "'candlestick'", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Function used to return formatting for individual columns, based on the given parameters. If the current column is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgCandlestickSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgCandlestickSeriesItemOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the series items." ], "name": "item", "type": "AgCandlestickSeriesItem", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgCandlestickSeriesItem": { "kind": "interface", "name": "AgCandlestickSeriesItem", "members": [ { "kind": "member", "docs": [ "Configuration for the rising series items." ], "name": "up", "type": "AgCandlestickSeriesItemOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the falling series items." ], "name": "down", "type": "AgCandlestickSeriesItemOptions", "optional": true } ] }, "AgCandlestickSeriesItemOptions": { "kind": "interface", "name": "AgCandlestickSeriesItemOptions", "members": [ { "kind": "member", "docs": [ "Options to style chart's wicks" ], "name": "wick", "type": "AgCandlestickWickOptions", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgCandlestickSeriesItemStylerParams": { "kind": "interface", "name": "AgCandlestickSeriesItemStylerParams", "members": [ { "kind": "member", "docs": [ "The unique identifier of the item." ], "name": "itemId", "type": "ItemType", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "ItemType": "AgOhlcSeriesItemType" } }, "AgCandlestickSeriesOptions": { "kind": "interface", "name": "AgCandlestickSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Candlestick Series." ], "name": "type", "type": "'candlestick'", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgCandlestickSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual columns, based on the given parameters. If the current column is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgCandlestickSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgCandlestickSeriesItemOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the series items." ], "name": "item", "type": "AgCandlestickSeriesItem", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgCandlestickSeriesStyles": { "kind": "interface", "name": "AgCandlestickSeriesStyles", "members": [ { "kind": "member", "docs": [ "Configuration used for the series items." ], "name": "item", "type": "AgCandlestickSeriesItem", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgCandlestickSeriesThemeOverrides": { "kind": "interface", "name": "AgCandlestickSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgCandlestickSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgCandlestickSeriesThemeableOptions": { "kind": "interface", "name": "AgCandlestickSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgCandlestickSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual columns, based on the given parameters. If the current column is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgCandlestickSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgCandlestickSeriesItemOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the series items." ], "name": "item", "type": "AgCandlestickSeriesItem", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgCandlestickSeriesTooltipRendererParams": { "kind": "interface", "name": "AgCandlestickSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "Direction of the datum" ], "name": "itemId", "type": { "kind": "union", "type": [ "'up'", "'down'" ] }, "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgCandlestickWickOptions": { "name": "AgCandlestickWickOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgCartesianAxesCrossLineThemeOptions": { "kind": "interface", "name": "AgCartesianAxesCrossLineThemeOptions", "members": [ { "kind": "member", "name": "crossLines", "type": "AgCrossLineThemeOptions", "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": { "kind": "union", "type": [ "Date", "number" ] }, "TInterval": { "kind": "union", "type": [ "TimeInterval", "number" ] }, "T": "AgTimeAxisOptions" } }, "AgCartesianAxesTheme": { "kind": "interface", "name": "AgCartesianAxesTheme", "members": [ { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to number axes." ], "name": "number", "type": "AgNumberAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to number axes." ], "name": "log", "type": "AgLogAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to category axes." ], "name": "category", "type": "AgCategoryAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to time axes." ], "name": "time", "type": "AgTimeAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to ordinal-time axes." ], "name": "'ordinal-time'", "type": "AgOrdinalTimeAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to grouped-category axes." ], "name": "'grouped-category'", "type": "AgGroupedCategoryAxisThemeOptions", "optional": true } ] }, "AgCartesianAxisLabelOptions": { "kind": "interface", "name": "AgCartesianAxisLabelOptions", "members": [ { "kind": "member", "docs": [ "If specified and axis labels may collide, they are rotated so that they are positioned at the supplied angle. This is enabled by default for category. If the `rotation` property is specified, it takes precedence." ], "name": "autoRotate", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "If autoRotate is enabled, specifies the rotation angle to use when autoRotate is activated. Defaults to an angle of 335 degrees if unspecified." ], "name": "autoRotateAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true } ] }, "AgCartesianAxisOptions": { "kind": "typeAlias", "name": "AgCartesianAxisOptions", "type": { "kind": "union", "type": [ "AgNumberAxisOptions", "AgLogAxisOptions", "AgCategoryAxisOptions", "AgOrdinalTimeAxisOptions", "AgGroupedCategoryAxisOptions", "AgTimeAxisOptions" ] } }, "AgCartesianAxisPosition": { "kind": "typeAlias", "name": "AgCartesianAxisPosition", "type": { "kind": "union", "type": [ "'top'", "'right'", "'bottom'", "'left'" ] } }, "AgCartesianAxisThemeOptions": { "kind": "interface", "name": "AgCartesianAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "An object with axis theme overrides for the `top` positioned axes. Same configs apply here as one level above. For example, to rotate labels by 45 degrees in 'top' positioned axes one can use `top: { label: { rotation: 45 } } }`." ], "name": "top", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `right` positioned axes. Same configs apply here as one level above." ], "name": "right", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `bottom` positioned axes. Same configs apply here as one level above." ], "name": "bottom", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `left` positioned axes. Same configs apply here as one level above." ], "name": "left", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": null, "default": null } ], "docs": [ "This is the configuration shared by all types of axis." ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": { "kind": "union", "type": [ "Date", "number" ] }, "TInterval": { "kind": "union", "type": [ "TimeInterval", "number" ] }, "T": "AgTimeAxisOptions" } }, "AgCartesianAxisThemeSpecialOptions": { "kind": "typeAlias", "name": "AgCartesianAxisThemeSpecialOptions", "type": { "kind": "union", "type": [ "'position'", "'type'", "'crossLines'" ] } }, "AgCartesianAxisType": { "kind": "typeAlias", "name": "AgCartesianAxisType", "type": { "kind": "union", "type": [ "'category'", "'grouped-category'", "'ordinal-time'", "'number'", "'log'", "'time'" ] } }, "AgCartesianChartOptions": { "kind": "interface", "name": "AgCartesianChartOptions", "members": [ { "kind": "member", "docs": [ "A predefined theme name or an object containing theme overrides.", "", " See: [Themes Reference](/themes-api/)" ], "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": { "kind": "array", "type": "AgCartesianAxisOptions" }, "optional": true }, { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgCartesianSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Annotations configurations." ], "name": "annotations", "type": "AgAnnotationsOptions", "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgCartesianCrossLineLabelOptions": { "kind": "interface", "name": "AgCartesianCrossLineLabelOptions", "members": [ { "kind": "member", "docs": [ "The position of the Cross Line label." ], "name": "position", "type": "AgCrossLineLabelPosition", "optional": true }, { "kind": "member", "docs": [ "The rotation of the Cross Line label in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Whether to show the Cross Line label." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The text to show in the label." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the label." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the label." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the label." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the label." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the label and the edge of the Cross Line." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the label." ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgCartesianCrossLineOptions": { "kind": "interface", "name": "AgCartesianCrossLineOptions", "members": [ { "kind": "member", "docs": [ "Type of Cross Line to render, defaults to `line`." ], "name": "type", "type": { "kind": "union", "type": [ "'line'", "'range'" ] }, "optional": false }, { "kind": "member", "docs": [ "Whether to show the Cross Line." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The data value at which the line should be positioned. This property is used if the Cross Line type is `line`." ], "name": "value", "type": "AxisValue", "optional": true }, { "kind": "member", "docs": [ "The range of values from the data used to display lines at a desired chart region. This property is only used for Cross Line type `range`." ], "name": "range", "type": { "kind": "tuple", "type": [ "AxisValue", "AxisValue" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour to use for the fill of the range." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the range." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour of the stroke for the lines." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the lines." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Cross Line label." ], "name": "label", "type": "LabelType", "optional": true } ], "genericsMap": { "LabelType": "AgCartesianCrossLineLabelOptions" } }, "AgCartesianSeriesOptions": { "kind": "typeAlias", "name": "AgCartesianSeriesOptions", "type": { "kind": "union", "type": [ "AgAreaSeriesOptions", "AgBarSeriesOptions", "AgBoxPlotSeriesOptions", "AgBubbleSeriesOptions", "AgCandlestickSeriesOptions", "AgConeFunnelSeriesOptions", "AgFunnelSeriesOptions", "AgHeatmapSeriesOptions", "AgHistogramSeriesOptions", "AgLineSeriesOptions", "AgOhlcSeriesOptions", "AgRangeAreaSeriesOptions", "AgRangeBarSeriesOptions", "AgScatterSeriesOptions", "AgWaterfallSeriesOptions" ] } }, "AgCartesianSeriesTooltipRendererParams": { "kind": "interface", "name": "AgCartesianSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "yKey as specified on series options." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgCategoryAxisOptions": { "kind": "interface", "name": "AgCategoryAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'category'", "optional": false }, { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The padding on the outside i.e. left and right of the first and last category. In association with `paddingInner`, this value can be between 0 and 1." ], "name": "paddingOuter", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped column/bar series plotted on a category axis. It is a proportion between 0 and 1 which determines the size of the gap between the bars or columns within a single group along the axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgCartesianCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true } ], "genericsMap": { "LabelType": "AgBaseCartesianAxisLabelOptions", "CrosshairLabelType": "AgBaseCrosshairLabel" } }, "AgCategoryAxisThemeOptions": { "kind": "interface", "name": "AgCategoryAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The padding on the outside i.e. left and right of the first and last category. In association with `paddingInner`, this value can be between 0 and 1." ], "name": "paddingOuter", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped column/bar series plotted on a category axis. It is a proportion between 0 and 1 which determines the size of the gap between the bars or columns within a single group along the axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `top` positioned axes. Same configs apply here as one level above. For example, to rotate labels by 45 degrees in 'top' positioned axes one can use `top: { label: { rotation: 45 } } }`." ], "name": "top", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `right` positioned axes. Same configs apply here as one level above." ], "name": "right", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `bottom` positioned axes. Same configs apply here as one level above." ], "name": "bottom", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `left` positioned axes. Same configs apply here as one level above." ], "name": "left", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "name": "crossLines", "type": "AgCrossLineThemeOptions", "optional": true } ], "genericsMap": { "LabelType": "AgBaseCartesianAxisLabelOptions", "CrosshairLabelType": "AgBaseCrosshairLabel", "T": "AgCategoryAxisOptions" } }, "AgChannelAnnotationBackground": { "kind": "interface", "name": "AgChannelAnnotationBackground", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgChannelAnnotationMiddle": { "kind": "interface", "name": "AgChannelAnnotationMiddle", "members": [ { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgChannelAnnotationStyles": { "kind": "interface", "name": "AgChannelAnnotationStyles", "members": [ { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "name": "middle", "type": "AgChannelAnnotationMiddle", "optional": true }, { "kind": "member", "docs": [ "The fill colour for the middle of the channel." ], "name": "background", "type": "AgChannelAnnotationBackground", "optional": true }, { "kind": "member", "name": "text", "type": "AgChannelAnnotationTextOptions", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgChannelAnnotationText": { "kind": "interface", "name": "AgChannelAnnotationText", "members": [ { "kind": "member", "name": "label", "type": "string", "optional": true }, { "kind": "member", "name": "position", "type": { "kind": "union", "type": [ "'top'", "'inside'", "'bottom'" ] }, "optional": true }, { "kind": "member", "name": "alignment", "type": { "kind": "union", "type": [ "'left'", "'center'", "'right'" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgChannelAnnotationTextOptions": { "kind": "interface", "name": "AgChannelAnnotationTextOptions", "members": [ { "kind": "member", "name": "position", "type": { "kind": "union", "type": [ "'top'", "'inside'", "'bottom'" ] }, "optional": true }, { "kind": "member", "name": "alignment", "type": { "kind": "union", "type": [ "'left'", "'center'", "'right'" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgChartAutoSizedBaseLabelOptions": { "kind": "interface", "name": "AgChartAutoSizedBaseLabelOptions", "members": [ { "kind": "member", "docs": [ "Line height to use for the label." ], "name": "lineHeight", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "If the label does not fit in the container, setting this will allow the label to pick a font size between its normal `fontSize` and `minimumFontSize` to fit within the container." ], "name": "minimumFontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for labels.", "- `'always'` will always wrap text to fit within the tile.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tile dimensions, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" }, { "kind": "member", "docs": [ "Adjusts the behaviour of labels when they overflow", "- `'ellipsis'` will truncate the text to fit, appending an ellipsis (...)", "- `'hide'` only displays the label if it completely fits within its bounds, and removes it if it would overflow" ], "name": "overflowStrategy", "type": "OverflowStrategy", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "undefined", "TParams": "AgRadialGaugeLabelFormatterParams" } }, "AgChartAutoSizedLabelOptions": { "kind": "interface", "name": "AgChartAutoSizedLabelOptions", "members": [ { "kind": "member", "docs": [ "The distance between the label and secondary label, if both are present" ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Line height to use for the label." ], "name": "lineHeight", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "If the label does not fit in the container, setting this will allow the label to pick a font size between its normal `fontSize` and `minimumFontSize` to fit within the container." ], "name": "minimumFontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for labels.", "- `'always'` will always wrap text to fit within the tile.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tile dimensions, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" }, { "kind": "member", "docs": [ "Adjusts the behaviour of labels when they overflow", "- `'ellipsis'` will truncate the text to fit, appending an ellipsis (...)", "- `'hide'` only displays the label if it completely fits within its bounds, and removes it if it would overflow" ], "name": "overflowStrategy", "type": "OverflowStrategy", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "undefined", "TParams": "AgRadialGaugeLabelFormatterParams" } }, "AgChartAutoSizedSecondaryLabelOptions": { "kind": "interface", "name": "AgChartAutoSizedSecondaryLabelOptions", "members": [ { "kind": "member", "docs": [ "Line height to use for the label." ], "name": "lineHeight", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "If the label does not fit in the container, setting this will allow the label to pick a font size between its normal `fontSize` and `minimumFontSize` to fit within the container." ], "name": "minimumFontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for labels.", "- `'always'` will always wrap text to fit within the tile.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tile dimensions, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" }, { "kind": "member", "docs": [ "Adjusts the behaviour of labels when they overflow", "- `'ellipsis'` will truncate the text to fit, appending an ellipsis (...)", "- `'hide'` only displays the label if it completely fits within its bounds, and removes it if it would overflow" ], "name": "overflowStrategy", "type": "OverflowStrategy", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "undefined", "TParams": "AgRadialGaugeLabelFormatterParams" } }, "AgChartBackground": { "kind": "interface", "name": "AgChartBackground", "members": [ { "kind": "member", "docs": [ "Whether the background should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Colour of the chart background." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Background image. May be combined with fill colour." ], "name": "image", "type": "AgChartBackgroundImage", "optional": true } ] }, "AgChartBackgroundImage": { "kind": "interface", "name": "AgChartBackgroundImage", "members": [ { "kind": "member", "docs": [ "URL of the image." ], "name": "url", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Distance from the left border of the chart to the left border of the image. If neither left nor right specified, the image is centred horizontally." ], "name": "left", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Distance from the top border of the chart to the top border of the image. If neither top nor bottom specified, the image is centred vertically." ], "name": "top", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Distance from the right border of the chart to the right border of the image. If neither left nor right specified, the image is centred horizontally." ], "name": "right", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Distance from the bottom border of the chart to the bottom border of the image. If neither top nor bottom specified, the image is centred vertically." ], "name": "bottom", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Width of the image. If both left and width are specified, right is ignored. If only height is provided, width will be computed to preserve the original width/height ratio. If neither is provided, the original width is used." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Height of the image. If both top and height are specified, bottom is ignored. If only width is provided, height will be computed to preserve the original width/height ratio. If neither is provided, the original height is used." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Opacity of the image." ], "name": "opacity", "type": "Opacity", "optional": true } ] }, "AgChartCallbackParams": { "kind": "interface", "name": "AgChartCallbackParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the item." ], "name": "itemId", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgChartCaptionOptions": { "kind": "interface", "name": "AgChartCaptionOptions", "members": [ { "kind": "member", "docs": [ "Whether the text should be shown." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The text to display." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the text." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the text." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the text." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the text." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the text." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the text." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Spacing added to help position the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the width of the title before text is wrapped or truncated." ], "name": "maxWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the height of the title before text is truncated." ], "name": "maxHeight", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for long text.", "- `'always'` will always wrap text to fit within the `maxWidth`.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" } ] }, "AgChartClickEvent": { "name": "AgChartClickEvent", "kind": "interface", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "name": "event", "type": "Event", "optional": false } ], "genericsMap": { "T": "'click'" } }, "AgChartContextMenuEvent": { "name": "AgChartContextMenuEvent", "kind": "interface", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "name": "event", "type": "Event", "optional": false } ], "genericsMap": { "T": "'contextMenuEvent'" } }, "AgChartDoubleClickEvent": { "name": "AgChartDoubleClickEvent", "kind": "interface", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "name": "event", "type": "Event", "optional": false } ], "genericsMap": { "T": "'doubleClick'" } }, "AgChartEvent": { "kind": "interface", "name": "AgChartEvent", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "name": "event", "type": "Event", "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": "string", "default": null } ], "genericsMap": { "T": "'seriesContextMenuAction'" } }, "AgChartFooterOptions": { "kind": "interface", "name": "AgChartFooterOptions", "members": [ { "kind": "member", "docs": [ "Whether the text should be shown." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The text to display." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the text." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the text." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the text." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the text." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the text." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the text." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Spacing added to help position the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the width of the title before text is wrapped or truncated." ], "name": "maxWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the height of the title before text is truncated." ], "name": "maxHeight", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for long text.", "- `'always'` will always wrap text to fit within the `maxWidth`.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" } ] }, "AgChartHighlightOptions": { "kind": "interface", "name": "AgChartHighlightOptions", "members": [ { "kind": "member", "docs": [ "By default, nodes will be highlighted when the cursor is within the `tooltip.range`. Set this to `'node'` to highlight nodes when within the `series[].nodeClickRange`." ], "name": "range", "type": "AgChartHighlightRange", "optional": true } ] }, "AgChartHighlightRange": { "kind": "typeAlias", "name": "AgChartHighlightRange", "type": { "kind": "union", "type": [ "'tooltip'", "'node'" ] } }, "AgChartInstance": { "kind": "interface", "name": "AgChartInstance", "members": [ { "kind": "member", "docs": [ "Update an existing `AgChartInstance`. Options provided should be complete and not partial.", "", "Returns a `Promise` that resolves once the requested change has been rendered.", "", "__NOTE:__ As each call could trigger a chart redraw, multiple calls in quick succession could result in undesirable flickering. Callers should batch up and/or debounce changes to avoid unintended partial update renderings." ], "name": "update", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "O" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Update an existing `AgChartInstance` by applying a partial set of option changes.", "", "Returns a `Promise` that resolves once the requested change has been rendered.", "", "__NOTE:__ As each call could trigger a chart redraw, each individual delta options update should leave the chart in a valid options state.", " Also, multiple calls in quick succession could result in undesirable flickering. Callers should batch up and/or debounce changes to avoid unintended partial update renderings." ], "name": "updateDelta", "type": { "kind": "function", "params": [ { "kind": "param", "name": "deltaOptions", "type": { "kind": "typeRef", "type": "DeepPartial", "typeArguments": [ "O" ] } } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Get the `AgChartOptions` representing the current chart configuration." ], "name": "getOptions", "type": { "kind": "function", "params": [], "returnType": "O" }, "optional": false }, { "kind": "member", "docs": [ "Returns a `Promise` that resolves once any pending changes have been rendered." ], "name": "waitForUpdate", "type": { "kind": "function", "params": [], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Starts a browser-based image download for the given `AgChartInstance`.", "", "Returns a `Promise` that resolves once the download has been initiated." ], "name": "download", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "DownloadOptions" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Reset animation state; treat the next AgChartInstance.update() as-if the chart is being created from scratch." ], "name": "resetAnimations", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false }, { "kind": "member", "docs": [ "Skip animations on the next redraw." ], "name": "skipAnimations", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false }, { "kind": "member", "docs": [ "Returns a base64-encoded image data URL for the given `AgChartInstance`." ], "name": "getImageDataURL", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "ImageDataUrlOptions" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "string" ] } }, "optional": false }, { "kind": "member", "docs": [ "Returns a representation of the current state of the given `AgChartInstance`." ], "name": "getState", "type": { "kind": "function", "params": [], "returnType": "AgChartState" }, "optional": false }, { "kind": "member", "docs": [ "Sets the state of the given `AgChartInstance` to the state provided." ], "name": "setState", "type": { "kind": "function", "params": [ { "kind": "param", "name": "state", "type": "AgChartState" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Destroy the chart instance and any allocated resources supporting its rendering." ], "name": "destroy", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "O", "constraint": "AgChartInstanceOptions", "default": "AgChartOptions" } ], "genericsMap": { "O": "AgChartOptions" } }, "AgChartInstanceOptions": { "kind": "typeAlias", "name": "AgChartInstanceOptions", "type": { "kind": "union", "type": [ "AgChartOptions", "AgPresetOptions" ] } }, "AgChartLabelFormatterParams": { "kind": "interface", "name": "AgChartLabelFormatterParams", "members": [ { "kind": "member", "docs": [ "The default label value that would have been used without a formatter." ], "name": "value", "type": "any", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the item." ], "name": "itemId", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgChartLabelOptions": { "kind": "interface", "name": "AgChartLabelOptions", "members": [ { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ], "docs": [ "Represents the configuration options for labels in an AgCharts.", " Labels are used to display textual information alongside data points in a chart.", "", "@typeparam TDatum - The type of data associated with the chart.", "@typeparam TParams - The type of parameters expected by the label formatter function." ], "genericsMap": { "TParams": { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } } }, "AgChartLegendClickEvent": { "kind": "interface", "name": "AgChartLegendClickEvent", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "docs": [ "Series id" ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Legend item id - usually yKey value for cartesian series." ], "name": "itemId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The browser event that triggered the legend event." ], "name": "event", "type": "Event", "optional": false }, { "kind": "member", "docs": [ "Prevent the AG Charts built-in default event handlers from running." ], "name": "preventDefault", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false } ], "genericsMap": { "T": "'click'" } }, "AgChartLegendContextMenuEvent": { "kind": "interface", "name": "AgChartLegendContextMenuEvent", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "docs": [ "Series id" ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Legend item id - usually yKey value for cartesian series." ], "name": "itemId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The browser event that triggered the legend event." ], "name": "event", "type": "Event", "optional": false } ], "genericsMap": { "T": "'contextmenu'" } }, "AgChartLegendDoubleClickEvent": { "kind": "interface", "name": "AgChartLegendDoubleClickEvent", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "docs": [ "Series id" ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Legend item id - usually yKey value for cartesian series." ], "name": "itemId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The browser event that triggered the legend event." ], "name": "event", "type": "Event", "optional": false }, { "kind": "member", "docs": [ "Prevent the AG Charts built-in default event handlers from running." ], "name": "preventDefault", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false } ], "genericsMap": { "T": "'dblclick'" } }, "AgChartLegendEvent": { "kind": "interface", "name": "AgChartLegendEvent", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "docs": [ "Series id" ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Legend item id - usually yKey value for cartesian series." ], "name": "itemId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The browser event that triggered the legend event." ], "name": "event", "type": "Event", "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": "string", "default": null } ], "genericsMap": { "T": "'dblclick'" } }, "AgChartLegendItemOptions": { "kind": "interface", "name": "AgChartLegendItemOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the legend markers." ], "name": "marker", "type": "AgChartLegendMarkerOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the legend lines." ], "name": "line", "type": "AgChartLegendLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the legend labels." ], "name": "label", "type": "AgChartLegendLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the width of legend items." ], "name": "maxWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The horizontal spacing in pixels to use between legend items." ], "name": "paddingX", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The vertical spacing in pixels to use between legend items." ], "name": "paddingY", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Set to `false` to hide the legend line line representing the stroke styling of line and area series. If enabled, legend marker will be hidden if series markers are disabled." ], "name": "showSeriesStroke", "type": "boolean", "optional": true } ] }, "AgChartLegendLabelFormatterParams": { "kind": "interface", "name": "AgChartLegendLabelFormatterParams", "members": [ { "kind": "member", "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "name": "itemId", "type": "any", "optional": false }, { "kind": "member", "name": "value", "type": "string", "optional": false }, { "kind": "member", "name": "datum", "type": "any", "optional": true } ] }, "AgChartLegendLabelOptions": { "kind": "interface", "name": "AgChartLegendLabelOptions", "members": [ { "kind": "member", "docs": [ "If the label text exceeds the specified number of characters, it will be truncated and an ellipsis will be appended to indicate this." ], "name": "maxLength", "type": "number", "optional": true }, { "kind": "member", "docs": [ "The colour of the text." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the legend." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the legend." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the legend." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the legend." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Function used to render legend labels. Where `id` is a series ID, `itemId` is component ID within a series, such as a field name or an item index." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgChartLegendLabelFormatterParams" ] }, "optional": true } ] }, "AgChartLegendLineOptions": { "kind": "interface", "name": "AgChartLegendLineOptions", "members": [ { "kind": "member", "docs": [ "The width in pixels of the stroke for line in the legend. This requires `showSeriesStroke` to be set to `true`." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The length of the legend item line in pixels. This requires `showSeriesStroke` to be set to `true`." ], "name": "length", "type": "PixelSize", "optional": true } ] }, "AgChartLegendListeners": { "kind": "interface", "name": "AgChartLegendListeners", "members": [ { "kind": "member", "docs": [ "The listener to call when a legend item is clicked." ], "name": "legendItemClick", "type": { "kind": "function", "params": [ { "kind": "param", "name": "event", "type": "AgChartLegendClickEvent" } ], "returnType": "void" }, "optional": true }, { "kind": "member", "docs": [ "The listener to call when a legend item is double-clicked." ], "name": "legendItemDoubleClick", "type": { "kind": "function", "params": [ { "kind": "param", "name": "event", "type": "AgChartLegendDoubleClickEvent" } ], "returnType": "void" }, "optional": true } ] }, "AgChartLegendMarkerOptions": { "kind": "interface", "name": "AgChartLegendMarkerOptions", "members": [ { "kind": "member", "docs": [ "The size in pixels of the markers in the legend." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "If set, overrides the marker shape from the series and the legend will show the specified marker shape instead. If not set, will use a marker shape matching the shape from the series, or fall back to `'square'` if there is none." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The padding in pixels between a legend marker and the corresponding label." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for markers in the legend." ], "name": "strokeWidth", "type": "PixelSize", "optional": true } ] }, "AgChartLegendOptions": { "kind": "interface", "name": "AgChartLegendOptions", "members": [ { "kind": "member", "docs": [ "Whether to show the legend. By default, the chart displays a legend when there is more than one series present." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Where the legend should show in relation to the chart." ], "name": "position", "type": "AgChartLegendPosition", "optional": true }, { "kind": "member", "docs": [ "How the legend items should be arranged." ], "name": "orientation", "type": "AgChartLegendOrientation", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the width of the legend." ], "name": "maxWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the height of the legend." ], "name": "maxHeight", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The spacing in pixels to use outside the legend." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the legend items that consist of a marker and a label." ], "name": "item", "type": "AgChartLegendItemOptions", "optional": true }, { "kind": "member", "docs": [ "Reverse the display order of legend items if `true`." ], "name": "reverseOrder", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Optional callbacks for specific legend-related events." ], "name": "listeners", "type": "AgChartLegendListeners", "optional": true }, { "kind": "member", "docs": [ "Configuration for the pagination controls." ], "name": "pagination", "type": "AgChartLegendPaginationOptions", "optional": true }, { "kind": "member", "docs": [ "Set to `true` to prevent the last visible series from being toggled hidden." ], "name": "preventHidingAll", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Set to `false` to turn off toggling of the series visibility in the chart when a legend item is clicked." ], "name": "toggleSeries", "type": "boolean", "optional": true } ] }, "AgChartLegendOrientation": { "kind": "typeAlias", "name": "AgChartLegendOrientation", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] } }, "AgChartLegendPaginationOptions": { "kind": "interface", "name": "AgChartLegendPaginationOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the pagination buttons." ], "name": "marker", "type": "AgPaginationMarkerOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for pagination buttons when a button is active." ], "name": "activeStyle", "type": "AgPaginationMarkerStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for pagination buttons when a button is inactive." ], "name": "inactiveStyle", "type": "AgPaginationMarkerStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for pagination buttons when a button is hovered over." ], "name": "highlightStyle", "type": "AgPaginationMarkerStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the pagination label." ], "name": "label", "type": "AgPaginationLabelOptions", "optional": true } ] }, "AgChartLegendPosition": { "kind": "typeAlias", "name": "AgChartLegendPosition", "type": { "kind": "union", "type": [ "'top'", "'right'", "'bottom'", "'left'" ] } }, "AgChartOptions": { "kind": "interface", "name": "AgChartOptions", "members": [ { "kind": "member", "docs": [ "A predefined theme name or an object containing theme overrides.", "", " See: [Themes Reference](/themes-api/)" ], "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": { "kind": "array", "type": "AgChartAxisOptions" }, "optional": true }, { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgChartSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Annotations configurations." ], "name": "annotations", "type": "AgAnnotationsOptions", "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgChartOverlayOptions": { "kind": "interface", "name": "AgChartOverlayOptions", "members": [ { "kind": "member", "docs": [ "Enabled or disable use of the overlay." ], "name": "enabled", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Text to render in the overlay." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A function for generating HTML element or string for overlay content." ], "name": "renderer", "type": { "kind": "typeRef", "type": "Renderer", "typeArguments": [ "never", "HTMLElement" ] }, "optional": true } ] }, "AgChartOverlaysOptions": { "kind": "interface", "name": "AgChartOverlaysOptions", "members": [ { "kind": "member", "docs": [ "An overlay to be displayed when there is no data." ], "name": "loading", "type": "AgChartOverlayOptions", "optional": true }, { "kind": "member", "docs": [ "An overlay to be displayed when there is no data." ], "name": "noData", "type": "AgChartOverlayOptions", "optional": true }, { "kind": "member", "docs": [ "An overlay to be displayed when there are no series visible." ], "name": "noVisibleSeries", "type": "AgChartOverlayOptions", "optional": true }, { "kind": "member", "docs": [ "An overlay to be displayed when chart is running in an unsupported browser." ], "name": "unsupportedBrowser", "type": "AgChartOverlayOptions", "optional": true } ] }, "AgChartPaddingOptions": { "kind": "interface", "name": "AgChartPaddingOptions", "members": [ { "kind": "member", "docs": [ "The number of pixels of padding at the top of the chart area." ], "name": "top", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The number of pixels of padding at the right of the chart area." ], "name": "right", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The number of pixels of padding at the bottom of the chart area." ], "name": "bottom", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The number of pixels of padding at the left of the chart area." ], "name": "left", "type": "PixelSize", "optional": true } ] }, "AgChartState": { "kind": "interface", "name": "AgChartState", "members": [ { "kind": "member", "name": "version", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The initial set of annotations to display on the chart." ], "name": "annotations", "type": { "kind": "array", "type": "AgAnnotation" }, "optional": true }, { "kind": "member", "name": "chartType", "type": "AgInitialStateChartType", "optional": true }, { "kind": "member", "docs": [ "The initial zoom state." ], "name": "zoom", "type": "AgInitialStateZoomOptions", "optional": true }, { "kind": "member", "docs": [ "The initial legend state." ], "name": "legend", "type": { "kind": "array", "type": "AgInitialStateLegendOptions" }, "optional": true } ] }, "AgChartSubtitleOptions": { "kind": "interface", "name": "AgChartSubtitleOptions", "members": [ { "kind": "member", "docs": [ "Whether the text should be shown." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The text to display." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the text." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the text." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the text." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the text." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the text." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the text." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Spacing added to help position the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the width of the title before text is wrapped or truncated." ], "name": "maxWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Used to constrain the height of the title before text is truncated." ], "name": "maxHeight", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for long text.", "- `'always'` will always wrap text to fit within the `maxWidth`.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the `maxWidth`, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" } ] }, "AgChartSyncOptions": { "kind": "interface", "name": "AgChartSyncOptions", "members": [ { "kind": "member", "docs": [ "Toggles the synchronization feature. It is implicitly enabled when configuration options are provided; otherwise, it defaults to `false`." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Specifies the synchronization group identifier for the chart. Omitting this assigns the chart to a default synchronization group." ], "name": "groupId", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Determines the axes to be synchronized across charts." ], "name": "axes", "type": { "kind": "union", "type": [ "'x'", "'y'", "'xy'" ] }, "optional": true, "defaultValue": "x" }, { "kind": "member", "docs": [ "Enables synchronization of node interactions across charts." ], "name": "nodeInteraction", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Enables synchronization of zoom actions across charts." ], "name": "zoom", "type": "boolean", "optional": true, "defaultValue": "true" } ] }, "AgChartTheme": { "kind": "interface", "name": "AgChartTheme", "members": [ { "kind": "member", "docs": [ "The name of the theme to base your theme on. Your custom theme will inherit all the configuration from the base theme, allowing you to override just the settings you wish to change using the `overrides` config (see below)." ], "name": "baseTheme", "type": "AgChartThemeName", "optional": true }, { "kind": "member", "docs": [ "The palette to use. If specified, this replaces the palette from the base theme." ], "name": "palette", "type": "AgChartThemePalette", "optional": true }, { "kind": "member", "docs": [ "Global parameters to set styles across the whole chart." ], "name": "params", "type": "AgChartThemeParams", "optional": true }, { "kind": "member", "docs": [ "Configuration from this object is merged over the defaults specified in the base theme." ], "name": "overrides", "type": "AgThemeOverrides", "optional": true } ], "docs": [ "This object is used to define the configuration for a custom chart theme." ] }, "AgChartThemeName": { "kind": "typeAlias", "name": "AgChartThemeName", "type": { "kind": "union", "type": [ "'ag-default'", "'ag-default-dark'", "'ag-sheets'", "'ag-sheets-dark'", "'ag-polychroma'", "'ag-polychroma-dark'", "'ag-vivid'", "'ag-vivid-dark'", "'ag-material'", "'ag-material-dark'", "'ag-financial'", "'ag-financial-dark'" ] } }, "AgChartThemeOptions": { "kind": "interface", "name": "AgChartThemeOptions", "members": [ { "kind": "member", "docs": [ "The palette to use. If specified, this replaces the palette from the base theme." ], "name": "palette", "type": "AgChartThemePalette", "optional": true }, { "kind": "member", "docs": [ "Global parameters to set styles across the whole chart." ], "name": "params", "type": "AgChartThemeParams", "optional": true }, { "kind": "member", "docs": [ "Configuration from this object is merged over the defaults specified in the base theme." ], "name": "overrides", "type": "AgThemeOverrides", "optional": true } ] }, "AgChartThemeOverrides": { "kind": "interface", "name": "AgChartThemeOverrides", "members": [ { "kind": "member", "docs": [ "Common theme overrides for series." ], "name": "common", "type": "AgCommonThemeableChartOptions", "optional": true }, { "kind": "member", "docs": [ "Line series theme overrides." ], "name": "line", "type": "AgLineSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Scatter series theme overrides." ], "name": "scatter", "type": "AgScatterSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Bubble series theme overrides." ], "name": "bubble", "type": "AgBubbleSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Area series theme overrides." ], "name": "area", "type": "AgAreaSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Bar series theme overrides." ], "name": "bar", "type": "AgBarSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Box-plot series theme overrides." ], "name": "'box-plot'", "type": "AgBoxPlotSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Candlestick series theme overrides." ], "name": "candlestick", "type": "AgCandlestickSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Cone Funnel series theme overrides." ], "name": "'cone-funnel'", "type": "AgConeFunnelSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Funnel series theme overrides." ], "name": "funnel", "type": "AgFunnelSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "ohlc series theme overrides." ], "name": "ohlc", "type": "AgOhlcSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Histogram series theme overrides." ], "name": "histogram", "type": "AgHistogramSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Heatmap series theme overrides." ], "name": "heatmap", "type": "AgHeatmapSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Waterfall series theme overrides." ], "name": "waterfall", "type": "AgWaterfallSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Range-bar series theme overrides." ], "name": "'range-bar'", "type": "AgRangeBarSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Range-area series theme overrides." ], "name": "'range-area'", "type": "AgRangeAreaSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Donut series theme overrides." ], "name": "donut", "type": "AgDonutSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Pie series theme overrides." ], "name": "pie", "type": "AgPieSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radar-line series theme overrides." ], "name": "'radar-line'", "type": "AgRadarLineSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radar-area series theme overrides." ], "name": "'radar-area'", "type": "AgRadarAreaSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radial-bar series theme overrides." ], "name": "'radial-bar'", "type": "AgRadialBarSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radial-column series theme overrides." ], "name": "'radial-column'", "type": "AgRadialColumnSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Nightingale series theme overrides." ], "name": "nightingale", "type": "AgNightingaleSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Sunburst series theme overrides." ], "name": "sunburst", "type": "AgSunburstSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Treemap series theme overrides." ], "name": "treemap", "type": "AgTreemapSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map shape series theme overrides." ], "name": "'map-shape'", "type": "AgMapShapeSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map line series theme overrides." ], "name": "'map-line'", "type": "AgMapLineSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map marker series theme overrides." ], "name": "'map-marker'", "type": "AgMapMarkerSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map shape background series theme overrides." ], "name": "'map-shape-background'", "type": "AgMapShapeBackgroundThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map line background series theme overrides." ], "name": "'map-line-background'", "type": "AgMapLineBackgroundThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Sankey series theme overrides." ], "name": "sankey", "type": "AgSankeyThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Chord series theme overrides." ], "name": "chord", "type": "AgChordThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Pyramid series theme overrides." ], "name": "pyramid", "type": "AgPyramidThemeOverrides", "optional": true } ] }, "AgChartThemePalette": { "kind": "interface", "name": "AgChartThemePalette", "members": [ { "kind": "member", "docs": [ "The array of fills to be used." ], "name": "fills", "type": { "kind": "array", "type": "AgColorType" }, "optional": true }, { "kind": "member", "docs": [ "The array of strokes to be used." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "name": "up", "type": "AgPaletteColors", "optional": true }, { "kind": "member", "name": "down", "type": "AgPaletteColors", "optional": true }, { "kind": "member", "name": "neutral", "type": "AgPaletteColors", "optional": true } ], "docs": [ "Palette used by the chart instance." ] }, "AgChartThemeParams": { "kind": "interface", "name": "AgChartThemeParams", "members": [ { "kind": "member", "docs": [ "Default colour for axis lines and ticks." ], "name": "axisColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Background colour of tooltips, menus, dialogs, toolbars and buttons." ], "name": "chromeBackgroundColor", "type": "CssColor", "optional": true, "defaultValue": "foregroundColor + backgroundColor" }, { "kind": "member", "docs": [ "Font family used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs." ], "name": "chromeFontFamily", "type": "FontFamily", "optional": true, "defaultValue": "fontFamily" }, { "kind": "member", "docs": [ "Font size used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs." ], "name": "chromeFontSize", "type": "FontSize", "optional": true, "defaultValue": "fontSize" }, { "kind": "member", "docs": [ "Font weight used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs." ], "name": "chromeFontWeight", "type": "FontWeight", "optional": true, "defaultValue": "fontWeight" }, { "kind": "member", "docs": [ "Default colour for text in tooltips, menus, dialogs, toolbars, buttons and text inputs." ], "name": "chromeTextColor", "type": "CssColor", "optional": true, "defaultValue": "textColor" }, { "kind": "member", "docs": [ "Colour of text that should stand out less than the default in tooltips, menus, dialogs, toolbars and buttons." ], "name": "chromeSubtleTextColor", "type": "CssColor", "optional": true, "defaultValue": "subtleTextColor" }, { "kind": "member", "docs": [ "Background colour of crosshair labels." ], "name": "crosshairLabelBackgroundColor", "type": "CssColor", "optional": true, "defaultValue": "foregroundColor" }, { "kind": "member", "docs": [ "Colour for text in crosshair labels." ], "name": "crosshairLabelTextColor", "type": "CssColor", "optional": true, "defaultValue": "backgroundColor" }, { "kind": "member", "docs": [ "Font family used for all text." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Default font weight used for all text." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "Default colour for grid lines." ], "name": "gridLineColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The outer chart padding." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The 'brand colour' for the chart, used wherever a non-neutral colour is required. Selections, focus outlines and checkboxes use the accent colour by default." ], "name": "accentColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Background colour of the chart. Most text, borders and backgrounds are defined as a blend between the background and foreground colors." ], "name": "backgroundColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Default colour for borders." ], "name": "borderColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Default colour for neutral UI elements. Most text, borders and backgrounds are defined as a blend between the background and foreground colors." ], "name": "foregroundColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Default font size used for all text. Titles and some other text are scaled to this font size." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "Background colour for text inputs." ], "name": "inputBackgroundColor", "type": "CssColor", "optional": true, "defaultValue": "backgroundColor" }, { "kind": "member", "docs": [ "Colour of text within text inputs." ], "name": "inputTextColor", "type": "CssColor", "optional": true, "defaultValue": "textColor" }, { "kind": "member", "docs": [ "Colour of text that should stand out less than the default." ], "name": "subtleTextColor", "type": "CssColor", "optional": true, "defaultValue": "foregroundColor + backgroundColor" }, { "kind": "member", "docs": [ "Default colour for all text." ], "name": "textColor", "type": "CssColor", "optional": true, "defaultValue": "foregroundColor" } ] }, "AgChartToolbarThemeableOptions": { "kind": "interface", "name": "AgChartToolbarThemeableOptions", "members": [ { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ] }, "AgChartTooltipOptions": { "kind": "interface", "name": "AgChartTooltipOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to disable tooltips for all series in the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Group multiple series into the same tooltip" ], "name": "mode", "type": "AgTooltipMode", "optional": true }, { "kind": "member", "docs": [ "The tooltip arrow is displayed by default, unless the container restricts it or a position offset is provided. To always display the arrow, set `showArrow` to `true`. To remove the arrow, set `showArrow` to `false`." ], "name": "showArrow", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Range from a point that triggers the tooltip to show. This will be used unless overridden by the series `tooltip.range` option." ], "name": "range", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "The position of the tooltip. This will be used unless overridden by the series `tooltip.range` option." ], "name": "position", "type": "AgTooltipPositionOptions", "optional": true }, { "kind": "member", "docs": [ "The configuration for tooltip pagination." ], "name": "pagination", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The time interval (in milliseconds) after which the tooltip is shown." ], "name": "delay", "type": "DurationMs", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for tooltips.", "- `'always'` will always wrap text to fit within the tooltip.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tooltip dimensions, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'hyphenate'" } ] }, "AgChartsApi": { "kind": "interface", "name": "AgChartsApi", "members": [ { "kind": "member", "docs": [ "Create a new `AgChartInstance` based upon the given configuration options." ], "name": "create", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "AgChartOptions" } ], "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": "AgChartOptions", "default": null } ], "returnType": { "kind": "typeRef", "type": "AgChartInstance", "typeArguments": [ "T" ] } }, "optional": false }, { "kind": "member", "docs": [ "Create a new `AgChartInstance` based upon the given configuration options." ], "name": "createFinancialChart", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "AgFinancialChartOptions" } ], "returnType": { "kind": "typeRef", "type": "AgChartInstance", "typeArguments": [ "AgFinancialChartOptions" ] } }, "optional": false }, { "kind": "member", "docs": [ "Create a new `AgChartInstance` based upon the given configuration options." ], "name": "createGauge", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "AgGaugeOptions" } ], "returnType": { "kind": "typeRef", "type": "AgChartInstance", "typeArguments": [ "AgGaugeOptions" ] } }, "optional": false }, { "kind": "member", "docs": [ "@private Internal to AG Grid, returns the `AgChartInstance` for a DOM node, if there is one." ], "name": "getInstance", "type": { "kind": "function", "params": [ { "kind": "param", "name": "element", "type": "HTMLElement" } ], "returnType": { "kind": "union", "type": [ "AgChartInstance", "undefined" ] } }, "optional": false } ] }, "AgChordSeriesLabelFormatterParams": { "kind": "interface", "name": "AgChordSeriesLabelFormatterParams", "members": [ { "kind": "member", "name": "size", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "_TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "_TDatum": "any" } }, "AgChordSeriesLabelOptions": { "kind": "interface", "name": "AgChordSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Spacing between a node and its label." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "If the label text exceeds the maximum length, it will be truncated and an ellipsis will be appended to indicate this." ], "name": "maxWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TParams": { "kind": "typeRef", "type": "AgChordSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } } }, "AgChordSeriesLinkItemStylerParams": { "kind": "interface", "name": "AgChordSeriesLinkItemStylerParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Tension of the links. 0 gives a maximally curved link, and 1 gives a straight line." ], "name": "tension", "type": "Ratio", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgChordSeriesLinkOptions": { "kind": "interface", "name": "AgChordSeriesLinkOptions", "members": [ { "kind": "member", "docs": [ "Function used to return formatting for individual links, based on the given parameters. If the current link is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgChordSeriesLinkItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgChordSeriesLinkStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Tension of the links. 0 gives a maximally curved link, and 1 gives a straight line." ], "name": "tension", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgChordSeriesLinkStyle": { "kind": "interface", "name": "AgChordSeriesLinkStyle", "members": [ { "kind": "member", "docs": [ "Tension of the links. 0 gives a maximally curved link, and 1 gives a straight line." ], "name": "tension", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgChordSeriesNodeItemStylerParams": { "kind": "interface", "name": "AgChordSeriesNodeItemStylerParams", "members": [ { "kind": "member", "docs": [ "Label of the node" ], "name": "label", "type": { "kind": "union", "type": [ "string", "undefined" ] }, "optional": false }, { "kind": "member", "docs": [ "Size of the node" ], "name": "size", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgChordSeriesNodeOptions": { "kind": "interface", "name": "AgChordSeriesNodeOptions", "members": [ { "kind": "member", "docs": [ "Minimum spacing between the nodes." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Width of the nodes." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual nodes, based on the given parameters. If the current node is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgChordSeriesNodeItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgChordSeriesNodeStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgChordSeriesNodeStyle": { "kind": "interface", "name": "AgChordSeriesNodeStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgChordSeriesOptions": { "kind": "interface", "name": "AgChordSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Chord Series." ], "name": "type", "type": "'chord'", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Options for the label for each node." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChordSeriesLabelOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the nodes and links." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the nodes and links." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Options for the links." ], "name": "link", "type": { "kind": "typeRef", "type": "AgChordSeriesLinkOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for the nodes." ], "name": "node", "type": { "kind": "typeRef", "type": "AgChordSeriesNodeOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgChordSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgChordSeriesOptionsKeys": { "kind": "interface", "name": "AgChordSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgChordSeriesOptionsNames": { "kind": "interface", "name": "AgChordSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgChordSeriesThemeableOptions": { "kind": "interface", "name": "AgChordSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Options for the label for each node." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChordSeriesLabelOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the nodes and links." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the nodes and links." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Options for the links." ], "name": "link", "type": { "kind": "typeRef", "type": "AgChordSeriesLinkOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for the nodes." ], "name": "node", "type": { "kind": "typeRef", "type": "AgChordSeriesNodeOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgChordSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgChordSeriesTooltipRendererParams": { "kind": "interface", "name": "AgChordSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "name": "size", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgChordThemeOverrides": { "kind": "interface", "name": "AgChordThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgChordSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgColorType": { "kind": "typeAlias", "name": "AgColorType", "type": { "kind": "union", "type": [ "CssColor", "AgGradientColor", "AgPatternColor" ] } }, "AgColorTypeStrict": { "kind": "typeAlias", "name": "AgColorTypeStrict", "type": { "kind": "union", "type": [ "CssColor", "AgGradientColorStrict" ] } }, "AgCommentAnnotation": { "kind": "interface", "name": "AgCommentAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the comment annotation." ], "name": "type", "type": "'comment'", "optional": false }, { "kind": "member", "docs": [ "The text content." ], "name": "text", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The x-value of the point." ], "name": "x", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "The y-value of the point." ], "name": "y", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgCommentAnnotationStyles": { "kind": "interface", "name": "AgCommentAnnotationStyles", "members": [ { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgCommonThemeableAxisOptions": { "kind": "interface", "name": "AgCommonThemeableAxisOptions", "members": [ { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to number axes." ], "name": "number", "type": "AgNumberAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to number axes." ], "name": "log", "type": "AgLogAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to category axes." ], "name": "category", "type": "AgCategoryAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to time axes." ], "name": "time", "type": "AgTimeAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to ordinal-time axes." ], "name": "'ordinal-time'", "type": "AgOrdinalTimeAxisThemeOptions", "optional": true }, { "kind": "member", "docs": [ "This extends the common axis configuration with options specific to grouped-category axes." ], "name": "'grouped-category'", "type": "AgGroupedCategoryAxisThemeOptions", "optional": true }, { "kind": "member", "name": "'angle-category'", "type": "AgAngleCategoryAxisThemeOptions", "optional": true }, { "kind": "member", "name": "'angle-number'", "type": "AgAngleNumberAxisThemeOptions", "optional": true }, { "kind": "member", "name": "'radius-category'", "type": "AgRadiusCategoryAxisThemeOptions", "optional": true }, { "kind": "member", "name": "'radius-number'", "type": "AgRadiusNumberAxisThemeOptions", "optional": true } ] }, "AgCommonThemeableChartOptions": { "kind": "interface", "name": "AgCommonThemeableChartOptions", "members": [ { "kind": "member", "name": "axes", "type": "AgCommonThemeableAxisOptions", "optional": true }, { "kind": "member", "name": "annotations", "type": "AgAnnotationsThemeableOptions", "optional": true }, { "kind": "member", "name": "chartToolbar", "type": "AgChartToolbarThemeableOptions", "optional": true }, { "kind": "member", "name": "initialState", "type": "AgInitialStateThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgConeFunnelSeriesItemStylerParams": { "kind": "interface", "name": "AgConeFunnelSeriesItemStylerParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgConeFunnelSeriesLabelFormatterParams": { "kind": "interface", "name": "AgConeFunnelSeriesLabelFormatterParams", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false } ] }, "AgConeFunnelSeriesLabelOptions": { "kind": "interface", "name": "AgConeFunnelSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Spacing between label and the associated divider." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The placement of the label in relation to the divider between drop-offs." ], "name": "placement", "type": { "kind": "union", "type": [ "'before'", "'middle'", "'after'" ] }, "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgConeFunnelSeriesOptions": { "kind": "interface", "name": "AgConeFunnelSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Cone Funnel Series." ], "name": "type", "type": "'cone-funnel'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the drop-offs." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the drop-offs." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the drop-offs." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the drop-offs." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the drop-offs." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on between drop-offs." ], "name": "label", "type": { "kind": "typeRef", "type": "AgConeFunnelSeriesLabelOptions", "typeArguments": [ "TDatum", "AgConeFunnelSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the stage labels." ], "name": "stageLabel", "type": "AgConeFunnelSeriesStageLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgConeFunnelSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgConeFunnelSeriesOptionsKeys": { "kind": "interface", "name": "AgConeFunnelSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "any" } }, "AgConeFunnelSeriesOptionsNames": { "kind": "interface", "name": "AgConeFunnelSeriesOptionsNames", "members": [], "genericsMap": { "TDatum": "any" } }, "AgConeFunnelSeriesStageLabelOptions": { "kind": "interface", "name": "AgConeFunnelSeriesStageLabelOptions", "members": [ { "kind": "member", "docs": [ "Placement of the label in relation to the chart." ], "name": "placement", "type": { "kind": "union", "type": [ "'before'", "'after'" ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true } ] }, "AgConeFunnelSeriesStyle": { "kind": "interface", "name": "AgConeFunnelSeriesStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgConeFunnelSeriesThemeOverrides": { "kind": "interface", "name": "AgConeFunnelSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgConeFunnelSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgConeFunnelSeriesThemeableOptions": { "kind": "interface", "name": "AgConeFunnelSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The colours to cycle through for the fills of the drop-offs." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the drop-offs." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the drop-offs." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the drop-offs." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the drop-offs." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on between drop-offs." ], "name": "label", "type": { "kind": "typeRef", "type": "AgConeFunnelSeriesLabelOptions", "typeArguments": [ "TDatum", "AgConeFunnelSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the stage labels." ], "name": "stageLabel", "type": "AgConeFunnelSeriesStageLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgConeFunnelSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgConeFunnelSeriesTooltipRendererParams": { "kind": "interface", "name": "AgConeFunnelSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgContextMenuAction": { "kind": "interface", "name": "AgContextMenuAction", "members": [ { "kind": "member", "docs": [ "The text to display in the context menu for the custom action." ], "name": "label", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Callback function for the custom action." ], "name": "action", "type": { "kind": "function", "params": [ { "kind": "param", "name": "event", "type": "TEvent" } ], "returnType": "void" }, "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "TEvent", "constraint": null, "default": "AgNodeContextMenuActionEvent" } ], "genericsMap": { "TEvent": "AgNodeContextMenuActionEvent" } }, "AgContextMenuOptions": { "kind": "interface", "name": "AgContextMenuOptions", "members": [ { "kind": "member", "docs": [ "Whether to show the context menu." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Custom actions displayed in the context menu when right-clicking anywhere on the chart." ], "name": "extraActions", "type": { "kind": "array", "type": { "kind": "typeRef", "type": "AgContextMenuAction", "typeArguments": [ "AgChartContextMenuEvent" ] } }, "optional": true }, { "kind": "member", "docs": [ "Custom actions displayed in the context menu when right-clicking anywhere on the series area." ], "name": "extraSeriesAreaActions", "type": { "kind": "array", "type": { "kind": "typeRef", "type": "AgContextMenuAction", "typeArguments": [ "AgSeriesAreaContextMenuActionEvent" ] } }, "optional": true }, { "kind": "member", "docs": [ "Custom actions displayed in the context menu when right-clicking on a series node." ], "name": "extraNodeActions", "type": { "kind": "array", "type": { "kind": "typeRef", "type": "AgContextMenuAction", "typeArguments": [ "AgNodeContextMenuActionEvent" ] } }, "optional": true }, { "kind": "member", "docs": [ "Custom actions displayed in the context menu when right-clicking on a legend item." ], "name": "extraLegendItemActions", "type": { "kind": "array", "type": { "kind": "typeRef", "type": "AgContextMenuAction", "typeArguments": [ "AgChartLegendContextMenuEvent" ] } }, "optional": true } ] }, "AgContinuousAxisOptions": { "kind": "interface", "name": "AgContinuousAxisOptions", "members": [ { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": "Date | number", "default": "number" }, { "kind": "typeParam", "name": "TInterval", "constraint": "TimeInterval | number", "default": "number" } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": { "kind": "union", "type": [ "Date", "number" ] }, "TInterval": { "kind": "union", "type": [ "TimeInterval", "number" ] } } }, "AgCrossLineAnnotation": { "kind": "interface", "name": "AgCrossLineAnnotation", "members": [ { "kind": "member", "docs": [ "Position of the annotation specified in terms of the axis values." ], "name": "value", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "Configuration for the annotation axis label." ], "name": "axisLabel", "type": "AgAnnotationAxisLabel", "optional": true }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgCrossLineAnnotationStyles": { "kind": "interface", "name": "AgCrossLineAnnotationStyles", "members": [ { "kind": "member", "name": "axisLabel", "type": "AgAnnotationAxisLabel", "optional": true }, { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgCrossLineLabelPosition": { "kind": "typeAlias", "name": "AgCrossLineLabelPosition", "type": { "kind": "union", "type": [ "'top'", "'left'", "'right'", "'bottom'", "'top-left'", "'top-right'", "'bottom-left'", "'bottom-right'", "'inside'", "'inside-left'", "'inside-right'", "'inside-top'", "'inside-bottom'", "'inside-top-left'", "'inside-bottom-left'", "'inside-top-right'", "'inside-bottom-right'" ] } }, "AgCrossLineThemeOptions": { "kind": "interface", "name": "AgCrossLineThemeOptions", "members": [ { "kind": "member", "docs": [ "Whether to show the Cross Line." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The data value at which the line should be positioned. This property is used if the Cross Line type is `line`." ], "name": "value", "type": "AxisValue", "optional": true }, { "kind": "member", "docs": [ "The range of values from the data used to display lines at a desired chart region. This property is only used for Cross Line type `range`." ], "name": "range", "type": { "kind": "tuple", "type": [ "AxisValue", "AxisValue" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour to use for the fill of the range." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the range." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour of the stroke for the lines." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the lines." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Cross Line label." ], "name": "label", "type": "LabelType", "optional": true } ], "genericsMap": { "LabelType": "AgBaseCrossLineLabelOptions" } }, "AgCrosshairLabel": { "kind": "interface", "name": "AgCrosshairLabel", "members": [ { "kind": "member", "docs": [ "Whether to show label when the crosshair is visible." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The horizontal offset in pixels for the label." ], "name": "xOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The vertical offset in pixels for the label." ], "name": "yOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to create the content for the label." ], "name": "renderer", "type": { "kind": "typeRef", "type": "Renderer", "typeArguments": [ "AgCrosshairLabelRendererParams", "AgCrosshairLabelRendererResult" ] }, "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true } ] }, "AgCrosshairLabelRendererParams": { "kind": "interface", "name": "AgCrosshairLabelRendererParams", "members": [ { "kind": "member", "docs": [ "Axis value that the label is being rendered for." ], "name": "value", "type": "any", "optional": false }, { "kind": "member", "docs": [ "If the axis value is a number, the fractional digits used to format the value." ], "name": "fractionDigits", "type": "number", "optional": true } ] }, "AgCrosshairLabelRendererResult": { "kind": "interface", "name": "AgCrosshairLabelRendererResult", "members": [ { "kind": "member", "docs": [ "Text for the label." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Label text colour." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Label background colour." ], "name": "backgroundColor", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Opacity of the label." ], "name": "opacity", "type": "Opacity", "optional": true } ] }, "AgCrosshairOptions": { "kind": "interface", "name": "AgCrosshairOptions", "members": [ { "kind": "member", "docs": [ "Whether to show the crosshair." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "When true, the crosshair snaps to the highlighted data point. By default this property is true." ], "name": "snap", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour of the stroke for the lines." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the lines." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The crosshair label configuration" ], "name": "label", "type": "LabelType", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "LabelType", "constraint": null, "default": "AgCrosshairLabel" } ], "genericsMap": { "LabelType": "AgCrosshairLabel" } }, "AgDataSourceCallbackParams": { "kind": "interface", "name": "AgDataSourceCallbackParams", "members": [ { "kind": "member", "docs": [ "The start of the visible window, if a time axis is available." ], "name": "windowStart", "type": "Date", "optional": true }, { "kind": "member", "docs": [ "The end of the visible window, if a time axis is available." ], "name": "windowEnd", "type": "Date", "optional": true } ] }, "AgDataSourceOptions": { "kind": "interface", "name": "AgDataSourceOptions", "members": [ { "kind": "member", "docs": [ "Asynchronous callback to load data into the chart." ], "name": "getData", "type": { "kind": "function", "params": [ { "kind": "param", "name": "params", "type": "AgDataSourceCallbackParams" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ { "kind": "array", "type": "TDatum" } ] } }, "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgDatePriceRangeAnnotation": { "kind": "interface", "name": "AgDatePriceRangeAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the price range annotation." ], "name": "type", "type": "'date-price-range'", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Configuration for the statistics." ], "name": "statistics", "type": "AgMeasurerAnnotationStatistics", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgDateRangeAnnotation": { "kind": "interface", "name": "AgDateRangeAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the date range annotation." ], "name": "type", "type": "'date-range'", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Whether the annotation should be extended up above." ], "name": "extendAbove", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended down below." ], "name": "extendBelow", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Configuration for the statistics." ], "name": "statistics", "type": "AgMeasurerAnnotationStatistics", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgDisjointChannelAnnotation": { "kind": "interface", "name": "AgDisjointChannelAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the disjoint-channel annotation." ], "name": "type", "type": "'disjoint-channel'", "optional": false }, { "kind": "member", "docs": [ "The height of the annotation along the y-axis at the start." ], "name": "startHeight", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The height of the annotation along the y-axis at the end." ], "name": "endHeight", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "The fill colour for the middle of the channel." ], "name": "background", "type": "AgChannelAnnotationBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the channel text." ], "name": "text", "type": "AgChannelAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgDonutInnerCircle": { "kind": "interface", "name": "AgDonutInnerCircle", "members": [ { "kind": "member", "docs": [ "The colour of the fill for the inner circle." ], "name": "fill", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill for the inner circle." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgDonutInnerLabel": { "kind": "interface", "name": "AgDonutInnerLabel", "members": [ { "kind": "member", "docs": [ "The text to show in the inner label." ], "name": "text", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The spacing in pixels before and after the inner label." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgDonutInnerLabelThemeOptions": { "kind": "interface", "name": "AgDonutInnerLabelThemeOptions", "members": [ { "kind": "member", "docs": [ "The spacing in pixels before and after the inner label." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgDonutSeriesCalloutOptions": { "kind": "interface", "name": "AgDonutSeriesCalloutOptions", "members": [ { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the callouts." ], "name": "colors", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The length in pixels of the callout lines." ], "name": "length", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for callout lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true } ] }, "AgDonutSeriesItemStylerParams": { "name": "AgDonutSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true } ] }, "AgDonutSeriesLabelFormatterParams": { "name": "AgDonutSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "calloutLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the sector label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "sectorLabelName", "type": "string", "optional": true } ] }, "AgDonutSeriesLabelOptions": { "kind": "interface", "name": "AgDonutSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Distance in pixels between the callout line and the label text." ], "name": "offset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Minimum angle in degrees required for a sector to show a label." ], "name": "minAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid callout label collision and overflow by automatically moving colliding labels or reducing the Donut radius. If set to `false`, callout labels may collide with each other and the Donut radius will not change to prevent clipping of callout labels." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgDonutSeriesOptions": { "kind": "interface", "name": "AgDonutSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Donut Series." ], "name": "type", "type": "'donut'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration for the text lines to display inside the series." ], "name": "innerLabels", "type": { "kind": "array", "type": "AgDonutInnerLabel" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the series title." ], "name": "title", "type": "AgDonutTitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels used outside the sectors." ], "name": "calloutLabel", "type": { "kind": "typeRef", "type": "AgDonutSeriesLabelOptions", "typeArguments": [ "TDatum", "AgDonutSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels used inside the sectors." ], "name": "sectorLabel", "type": { "kind": "typeRef", "type": "AgDonutSeriesSectorLabelOptions", "typeArguments": [ "TDatum", "AgDonutSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the callout lines used with the labels for the sectors." ], "name": "calloutLine", "type": "AgDonutSeriesCalloutOptions", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the sectors." ], "name": "fills", "type": { "kind": "array", "type": "AgColorType" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the sectors." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the sectors." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the sectors." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the sectors." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The rotation of the Donut series in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "The offset in pixels of the outer radius of the series." ], "name": "outerRadiusOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The ratio of the outer radius of the series. Used to adjust the outer radius proportionally to the automatically calculated value." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The offset in pixels of the inner radius of the series." ], "name": "innerRadiusOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The ratio of the inner radius of the series." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true, "defaultValue": "0.7" }, { "kind": "member", "docs": [ "Override of the automatically determined minimum radiusKey value from the data." ], "name": "radiusMin", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Override of the automatically determined maximum radiusKey value from the data." ], "name": "radiusMax", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgDonutSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the area inside the series." ], "name": "innerCircle", "type": "AgDonutInnerCircle", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The spacing between Donut sectors." ], "name": "sectorSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether items with a value of 0 should be hidden in the legend." ], "name": "hideZeroValueSectorsInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the Donut sectors." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgDonutSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgDonutSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "calloutLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the sector label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "sectorLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgDonutSeriesOptionsKeys": { "kind": "interface", "name": "AgDonutSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgDonutSeriesOptionsNames": { "kind": "interface", "name": "AgDonutSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "calloutLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the sector label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "sectorLabelName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgDonutSeriesSectorLabelOptions": { "kind": "interface", "name": "AgDonutSeriesSectorLabelOptions", "members": [ { "kind": "member", "docs": [ "Distance in pixels, used to make the label text closer to or further from the center. This offset is applied after positionRatio." ], "name": "positionOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Position of labels as a ratio proportional to Donut radius (or Donut thickness). Additional offset in pixels can be applied by using positionOffset." ], "name": "positionRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgDonutSeriesStyle": { "kind": "interface", "name": "AgDonutSeriesStyle", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgDonutSeriesThemeOverrides": { "kind": "interface", "name": "AgDonutSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgDonutSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgDonutSeriesThemeableOptions": { "kind": "interface", "name": "AgDonutSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the series title." ], "name": "title", "type": "AgDonutTitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels used outside the sectors." ], "name": "calloutLabel", "type": { "kind": "typeRef", "type": "AgDonutSeriesLabelOptions", "typeArguments": [ "TDatum", "AgDonutSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels used inside the sectors." ], "name": "sectorLabel", "type": { "kind": "typeRef", "type": "AgDonutSeriesSectorLabelOptions", "typeArguments": [ "TDatum", "AgDonutSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the callout lines used with the labels for the sectors." ], "name": "calloutLine", "type": "AgDonutSeriesCalloutOptions", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the sectors." ], "name": "fills", "type": { "kind": "array", "type": "AgColorType" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the sectors." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the sectors." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the sectors." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the sectors." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The rotation of the Donut series in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "The offset in pixels of the outer radius of the series." ], "name": "outerRadiusOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The ratio of the outer radius of the series. Used to adjust the outer radius proportionally to the automatically calculated value." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The offset in pixels of the inner radius of the series." ], "name": "innerRadiusOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The ratio of the inner radius of the series." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true, "defaultValue": "0.7" }, { "kind": "member", "docs": [ "Override of the automatically determined minimum radiusKey value from the data." ], "name": "radiusMin", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Override of the automatically determined maximum radiusKey value from the data." ], "name": "radiusMax", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgDonutSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the text lines to display inside the series." ], "name": "innerLabels", "type": "AgDonutInnerLabelThemeOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the area inside the series." ], "name": "innerCircle", "type": "AgDonutInnerCircle", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The spacing between Donut sectors." ], "name": "sectorSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether items with a value of 0 should be hidden in the legend." ], "name": "hideZeroValueSectorsInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the Donut sectors." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgDonutSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgDonutSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgDonutSeriesTooltipRendererParams": { "kind": "interface", "name": "AgDonutSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "calloutLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the sector label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "sectorLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgDonutTitleOptions": { "kind": "interface", "name": "AgDonutTitleOptions", "members": [ { "kind": "member", "docs": [ "The text to display." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Spacing added to help position the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether the title text should be shown in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgDropShadowOptions": { "kind": "interface", "name": "AgDropShadowOptions", "members": [ { "kind": "member", "docs": [ "Whether the shadow is visible." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour of the shadow." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The horizontal offset in pixels for the shadow." ], "name": "xOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The vertical offset in pixels for the shadow." ], "name": "yOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The radius of the shadow's blur, given in pixels." ], "name": "blur", "type": "PixelSize", "optional": true } ] }, "AgErrorBarItemStylerParams": { "name": "AgErrorBarItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Options to style error bars' caps" ], "name": "cap", "type": "ErrorBarCapOptions", "optional": false }, { "kind": "member", "docs": [ "Whether to display the error bars." ], "name": "visible", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the x-axis data." ], "name": "xLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the x-axis data." ], "name": "xUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the y-axis data." ], "name": "yLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the y-axis data." ], "name": "yUpperKey", "type": "string", "optional": true } ] }, "AgErrorBarOptions": { "kind": "interface", "name": "AgErrorBarOptions", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the x-axis data." ], "name": "xLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the x-axis data." ], "name": "xUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the y-axis data." ], "name": "yLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the y-axis data." ], "name": "yUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the x-axis. This is the value to use in tooltips or labels." ], "name": "xLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the x-axis. This is the value to use in tooltips or labels." ], "name": "xUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the y-axis. This is the value to use in tooltips or labels." ], "name": "yLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the y-axis. This is the value to use in tooltips or labels." ], "name": "yUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual error bars, based on the given parameters. If the current error bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgErrorBarItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgErrorBarThemeableOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "Options to style error bars' caps" ], "name": "cap", "type": "ErrorBarCapOptions", "optional": true }, { "kind": "member", "docs": [ "Whether to display the error bars." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgErrorBarThemeableOptions": { "kind": "interface", "name": "AgErrorBarThemeableOptions", "members": [ { "kind": "member", "docs": [ "Options to style error bars' caps" ], "name": "cap", "type": "ErrorBarCapOptions", "optional": true }, { "kind": "member", "docs": [ "Whether to display the error bars." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgErrorBoundSeriesTooltipRendererParams": { "kind": "interface", "name": "AgErrorBoundSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the x axis data." ], "name": "xLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The x-axis lower bound error value." ], "name": "xLowerValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the x axis. This is the value to use in tooltips or labels." ], "name": "xLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the x axis data." ], "name": "xUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The x-axis upper bound error value." ], "name": "xUpperValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the x axis. This is the value to use in tooltips or labels." ], "name": "xUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the y axis data." ], "name": "yLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The y-axis lower bound error value." ], "name": "yLowerValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the y axis. This is the value to use in tooltips or labels." ], "name": "yLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the y axis data." ], "name": "yUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The y-axis upper bound error value." ], "name": "yUpperValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the y axis. This is the value to use in tooltips or labels." ], "name": "yUpperName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgFibonacciAnnotation": { "kind": "interface", "name": "AgFibonacciAnnotation", "members": [ { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the one line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Reverse the lines if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the fibonacci ratio labels." ], "name": "label", "type": "FontOptions", "optional": true }, { "kind": "member", "docs": [ "Whether to show the fills between the Fibonacci range lines." ], "name": "showFill", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Whether the Fibonacci range lines are multicoloured." ], "name": "isMultiColor", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the Fibonacci lines." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colour for the strokes of the Fibonacci lines if isMultiColor is `false`." ], "name": "rangeStroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The number of fibonacci range bands." ], "name": "bands", "type": { "kind": "union", "type": [ "10", "6", "4" ] }, "optional": true } ] }, "AgFibonacciAnnotationStyles": { "kind": "interface", "name": "AgFibonacciAnnotationStyles", "members": [ { "kind": "member", "docs": [ "Configuration for the fibonacci ratio labels." ], "name": "label", "type": "FontOptions", "optional": true }, { "kind": "member", "docs": [ "Whether to show the fills between the Fibonacci range lines." ], "name": "showFill", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Whether the Fibonacci range lines are multicoloured." ], "name": "isMultiColor", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the Fibonacci lines." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colour for the strokes of the Fibonacci lines if isMultiColor is `false`." ], "name": "rangeStroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The number of fibonacci range bands." ], "name": "bands", "type": { "kind": "union", "type": [ "10", "6", "4" ] }, "optional": true }, { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgFibonacciRetracementAnnotation": { "kind": "interface", "name": "AgFibonacciRetracementAnnotation", "members": [ { "kind": "member", "name": "type", "type": "'fibonacci-retracement'", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the one line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Reverse the lines if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the fibonacci ratio labels." ], "name": "label", "type": "FontOptions", "optional": true }, { "kind": "member", "docs": [ "Whether to show the fills between the Fibonacci range lines." ], "name": "showFill", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Whether the Fibonacci range lines are multicoloured." ], "name": "isMultiColor", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the Fibonacci lines." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colour for the strokes of the Fibonacci lines if isMultiColor is `false`." ], "name": "rangeStroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The number of fibonacci range bands." ], "name": "bands", "type": { "kind": "union", "type": [ "10", "6", "4" ] }, "optional": true } ] }, "AgFibonacciRetracementTrendBasedAnnotation": { "kind": "interface", "name": "AgFibonacciRetracementTrendBasedAnnotation", "members": [ { "kind": "member", "name": "type", "type": "'fibonacci-retracement-trend-based'", "optional": false }, { "kind": "member", "docs": [ "The retracmeent end point of the fibonacci annotation." ], "name": "endRetracement", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the one line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Reverse the lines if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the fibonacci ratio labels." ], "name": "label", "type": "FontOptions", "optional": true }, { "kind": "member", "docs": [ "Whether to show the fills between the Fibonacci range lines." ], "name": "showFill", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Whether the Fibonacci range lines are multicoloured." ], "name": "isMultiColor", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the Fibonacci lines." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colour for the strokes of the Fibonacci lines if isMultiColor is `false`." ], "name": "rangeStroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The number of fibonacci range bands." ], "name": "bands", "type": { "kind": "union", "type": [ "10", "6", "4" ] }, "optional": true } ] }, "AgFinancialChartOptions": { "name": "AgFinancialChartOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "A predefined theme name or an object containing theme overrides.", "", " See: [Themes Reference](/themes-api/)" ], "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series type used for the OHLC data." ], "name": "chartType", "type": "AgPriceVolumeChartType", "optional": true, "defaultValue": "'candlestick'" }, { "kind": "member", "docs": [ "The key used to retrieve x-values from the data." ], "name": "dateKey", "type": "string", "optional": true, "defaultValue": "'date'" }, { "kind": "member", "docs": [ "The key used to retrieve 'open' values from the data." ], "name": "openKey", "type": "string", "optional": true, "defaultValue": "'open'" }, { "kind": "member", "docs": [ "The key used to retrieve 'high' values from the data." ], "name": "highKey", "type": "string", "optional": true, "defaultValue": "'high'" }, { "kind": "member", "docs": [ "The key used to retrieve 'low' values from the data." ], "name": "lowKey", "type": "string", "optional": true, "defaultValue": "'low'" }, { "kind": "member", "docs": [ "The key used to retrieve 'close' values from the data." ], "name": "closeKey", "type": "string", "optional": true, "defaultValue": "'close'" }, { "kind": "member", "docs": [ "The key used to retrieve 'volume' values from the data." ], "name": "volumeKey", "type": "string", "optional": true, "defaultValue": "'volume'" }, { "kind": "member", "docs": [ "Whether to show the Navigator and mini-chart beneath the main chart." ], "name": "navigator", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether to show the volume series at the bottom of the chart.", " If set to `false`, no volume data is required." ], "name": "volume", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether to show the range buttons." ], "name": "rangeButtons", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether to show the status bar." ], "name": "statusBar", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether the toolbar is enabled." ], "name": "toolbar", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether Zoom is enabled." ], "name": "zoom", "type": "boolean", "optional": true, "defaultValue": "true" } ], "genericsMap": { "TDatum": "any" } }, "AgFinancialChartPresets": { "kind": "interface", "name": "AgFinancialChartPresets", "members": [ { "kind": "member", "docs": [ "Series type used for the OHLC data." ], "name": "chartType", "type": "AgPriceVolumeChartType", "optional": true, "defaultValue": "'candlestick'" }, { "kind": "member", "docs": [ "The key used to retrieve x-values from the data." ], "name": "dateKey", "type": "string", "optional": true, "defaultValue": "'date'" }, { "kind": "member", "docs": [ "The key used to retrieve 'open' values from the data." ], "name": "openKey", "type": "string", "optional": true, "defaultValue": "'open'" }, { "kind": "member", "docs": [ "The key used to retrieve 'high' values from the data." ], "name": "highKey", "type": "string", "optional": true, "defaultValue": "'high'" }, { "kind": "member", "docs": [ "The key used to retrieve 'low' values from the data." ], "name": "lowKey", "type": "string", "optional": true, "defaultValue": "'low'" }, { "kind": "member", "docs": [ "The key used to retrieve 'close' values from the data." ], "name": "closeKey", "type": "string", "optional": true, "defaultValue": "'close'" }, { "kind": "member", "docs": [ "The key used to retrieve 'volume' values from the data." ], "name": "volumeKey", "type": "string", "optional": true, "defaultValue": "'volume'" }, { "kind": "member", "docs": [ "Whether to show the Navigator and mini-chart beneath the main chart." ], "name": "navigator", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether to show the volume series at the bottom of the chart.", " If set to `false`, no volume data is required." ], "name": "volume", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether to show the range buttons." ], "name": "rangeButtons", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether to show the status bar." ], "name": "statusBar", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether the toolbar is enabled." ], "name": "toolbar", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether Zoom is enabled." ], "name": "zoom", "type": "boolean", "optional": true, "defaultValue": "true" } ], "genericsMap": { "TDatum": "any" } }, "AgFlowProportionChartOptions": { "kind": "interface", "name": "AgFlowProportionChartOptions", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgFlowProportionSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Nodes to use instead of inferring from data." ], "name": "nodes", "type": { "kind": "array", "type": "any" }, "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgFlowProportionSeriesOptions": { "kind": "typeAlias", "name": "AgFlowProportionSeriesOptions", "type": { "kind": "union", "type": [ "AgSankeySeriesOptions", "AgChordSeriesOptions" ] } }, "AgFunnelSeriesDropOff": { "kind": "interface", "name": "AgFunnelSeriesDropOff", "members": [ { "kind": "member", "docs": [ "Whether to draw drop-offs between adjacent bars." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgFunnelSeriesItemStylerParams": { "kind": "interface", "name": "AgFunnelSeriesItemStylerParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgFunnelSeriesLabelFormatterParams": { "kind": "interface", "name": "AgFunnelSeriesLabelFormatterParams", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false } ] }, "AgFunnelSeriesLabelOptions": { "kind": "interface", "name": "AgFunnelSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgFunnelSeriesOptions": { "kind": "interface", "name": "AgFunnelSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Funnel Series." ], "name": "type", "type": "'funnel'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the bars." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the bars." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the bars." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the bars." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the bars." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a bar and the start of the next bar." ], "name": "spacingRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Configuration for drop-offs between adjacent bars." ], "name": "dropOff", "type": "AgFunnelSeriesDropOff", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Align bars to whole pixel values to remove anti-aliasing." ], "name": "crisp", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on bars." ], "name": "label", "type": { "kind": "typeRef", "type": "AgFunnelSeriesLabelOptions", "typeArguments": [ "TDatum", "AgFunnelSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the stage labels." ], "name": "stageLabel", "type": "AgFunnelSeriesStageLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgFunnelSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual bars, based on the given parameters. If the current bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgFunnelSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgFunnelSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgFunnelSeriesOptionsKeys": { "kind": "interface", "name": "AgFunnelSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "any" } }, "AgFunnelSeriesOptionsNames": { "kind": "interface", "name": "AgFunnelSeriesOptionsNames", "members": [], "genericsMap": { "TDatum": "any" } }, "AgFunnelSeriesStageLabelOptions": { "kind": "interface", "name": "AgFunnelSeriesStageLabelOptions", "members": [ { "kind": "member", "docs": [ "Placement of the label in relation to the chart." ], "name": "placement", "type": { "kind": "union", "type": [ "'before'", "'after'" ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true } ] }, "AgFunnelSeriesStyle": { "kind": "interface", "name": "AgFunnelSeriesStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgFunnelSeriesThemeOverrides": { "kind": "interface", "name": "AgFunnelSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgFunnelSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgFunnelSeriesThemeableOptions": { "kind": "interface", "name": "AgFunnelSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The colours to cycle through for the fills of the bars." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the bars." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the bars." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the bars." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the bars." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a bar and the start of the next bar." ], "name": "spacingRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Configuration for drop-offs between adjacent bars." ], "name": "dropOff", "type": "AgFunnelSeriesDropOff", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Align bars to whole pixel values to remove anti-aliasing." ], "name": "crisp", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on bars." ], "name": "label", "type": { "kind": "typeRef", "type": "AgFunnelSeriesLabelOptions", "typeArguments": [ "TDatum", "AgFunnelSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the stage labels." ], "name": "stageLabel", "type": "AgFunnelSeriesStageLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgFunnelSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual bars, based on the given parameters. If the current bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgFunnelSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgFunnelSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgFunnelSeriesTooltipRendererParams": { "kind": "interface", "name": "AgFunnelSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgGaugeChartOptions": { "kind": "interface", "name": "AgGaugeChartOptions", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgGaugeColorStop": { "kind": "interface", "name": "AgGaugeColorStop", "members": [ { "kind": "member", "docs": [ "Colour of this category." ], "name": "color", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Stop value of this category. Defaults the maximum value if unset." ], "name": "stop", "type": "number", "optional": true } ] }, "AgGaugeCornerMode": { "kind": "typeAlias", "name": "AgGaugeCornerMode", "type": { "kind": "union", "type": [ "'container'", "'item'" ] } }, "AgGaugeFillMode": { "kind": "typeAlias", "name": "AgGaugeFillMode", "type": { "kind": "union", "type": [ "'continuous'", "'discrete'" ] } }, "AgGaugeOptions": { "name": "AgGaugeOptions", "kind": "interface", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgGaugePresets": { "kind": "typeAlias", "name": "AgGaugePresets", "type": { "kind": "union", "type": [ "AgLinearGaugePreset", "AgRadialGaugePreset" ] }, "genericsMap": { "TDatum": "any" } }, "AgGaugeScaleLabel": { "kind": "interface", "name": "AgGaugeScaleLabel", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the scale labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the scale label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The rotation of the scale labels in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid scale label collision by automatically reducing the number of ticks displayed. If set to `false`, scale labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the scale labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to render scale labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true } ] }, "AgGaugeSegmentation": { "kind": "interface", "name": "AgGaugeSegmentation", "members": [ { "kind": "member", "docs": [ "Enable segmentation." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the segmentation." ], "name": "interval", "type": "AgGaugeSegmentationInterval", "optional": true }, { "kind": "member", "docs": [ "The spacing between segments." ], "name": "spacing", "type": "number", "optional": true } ] }, "AgGaugeSegmentationInterval": { "kind": "interface", "name": "AgGaugeSegmentationInterval", "members": [ { "kind": "member", "docs": [ "The segmentation interval. If the configured interval results in too many items given the chart size, it will be ignored." ], "name": "step", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Array of values for specified intervals along the gauge." ], "name": "values", "type": { "kind": "array", "type": "number" }, "optional": true }, { "kind": "member", "docs": [ "Number of evenly-divided segments in the gauge." ], "name": "count", "type": "number", "optional": true } ] }, "AgGaugeThemeOverrides": { "kind": "typeAlias", "name": "AgGaugeThemeOverrides", "type": { "kind": "union", "type": [ "AgRadialGaugeThemeOverrides", "AgLinearGaugeThemeOverrides" ] } }, "AgGradientColor": { "kind": "interface", "name": "AgGradientColor", "members": [ { "kind": "member", "name": "type", "type": "'gradient'", "optional": false }, { "kind": "member", "docs": [ "Represents the position and color of stops in the gradient." ], "name": "colorStops", "type": { "kind": "array", "type": "AgGradientColorStop" }, "optional": true }, { "kind": "member", "docs": [ "The rotation angle of the line along which the gradient is rendered." ], "name": "rotation", "type": "number", "optional": true } ] }, "AgGradientColorBounds": { "kind": "typeAlias", "name": "AgGradientColorBounds", "type": { "kind": "union", "type": [ "'series'", "'item'", "'axis'" ] } }, "AgGradientColorMode": { "kind": "typeAlias", "name": "AgGradientColorMode", "type": { "kind": "union", "type": [ "'continuous'", "'discrete'" ] } }, "AgGradientColorStop": { "kind": "interface", "name": "AgGradientColorStop", "members": [ { "kind": "member", "docs": [ "Colour of this category." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Stop value of this category. Defaults the maximum value if unset." ], "name": "stop", "type": "Ratio", "optional": true } ] }, "AgGradientColorStrict": { "kind": "interface", "name": "AgGradientColorStrict", "members": [ { "kind": "member", "name": "type", "type": "'gradient'", "optional": false }, { "kind": "member", "docs": [ "Represents the position and color of stops in the gradient." ], "name": "colorStops", "type": { "kind": "array", "type": "AgGradientColorStop" }, "optional": false }, { "kind": "member", "docs": [ "The rotation angle of the line along which the gradient is rendered." ], "name": "rotation", "type": "number", "optional": true } ] }, "AgGradientLegendBarOptions": { "kind": "interface", "name": "AgGradientLegendBarOptions", "members": [ { "kind": "member", "docs": [ "Preferred length of the gradient bar (may expand to fit labels or shrink to fit inside a chart)." ], "name": "preferredLength", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The thickness of the gradient bar (width for vertical or height for horizontal layout)." ], "name": "thickness", "type": "PixelSize", "optional": true } ] }, "AgGradientLegendLabelOptions": { "kind": "interface", "name": "AgGradientLegendLabelOptions", "members": [ { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to render scale labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between intervals; for example, a interval step of `0.0005` would have `fractionDigits` set to `4`." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true } ] }, "AgGradientLegendOptions": { "kind": "interface", "name": "AgGradientLegendOptions", "members": [ { "kind": "member", "docs": [ "Whether to show the gradient legend. By default, the chart displays a gradient legend for series using a `colorKey`." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Where the legend should show in relation to the chart." ], "name": "position", "type": "AgChartLegendPosition", "optional": true }, { "kind": "member", "docs": [ "Gradient bar configuration." ], "name": "gradient", "type": "AgGradientLegendBarOptions", "optional": true }, { "kind": "member", "docs": [ "The spacing in pixels to use outside the legend." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Reverse the display order of legend items if `true`." ], "name": "reverseOrder", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Options for the numbers that appear below or to the side of the gradient." ], "name": "scale", "type": "AgGradientLegendScaleOptions", "optional": true } ] }, "AgGradientLegendScaleOptions": { "kind": "interface", "name": "AgGradientLegendScaleOptions", "members": [ { "kind": "member", "docs": [ "Options for the labels on the scale." ], "name": "label", "type": "AgGradientLegendLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Distance between the gradient box and the labels." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Options for intervals on the scale." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "number" ] }, "optional": true } ] }, "AgGradientType": { "kind": "typeAlias", "name": "AgGradientType", "type": { "kind": "union", "type": [ "'linear'", "'radial'", "'conic'" ] } }, "AgGroupedCategoryAxisLabelOptions": { "kind": "interface", "name": "AgGroupedCategoryAxisLabelOptions", "members": [ { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgGroupedCategoryAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgGroupedCategoryAxisLabelStylerParams": { "kind": "interface", "name": "AgGroupedCategoryAxisLabelStylerParams", "members": [ { "kind": "member", "docs": [ "The depth of the label, used by `grouped-category` axes." ], "name": "depth", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The label value that would be used, after applying formating." ], "name": "value", "type": "any", "optional": false }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgGroupedCategoryAxisOptions": { "kind": "interface", "name": "AgGroupedCategoryAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'grouped-category'", "optional": false }, { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped column/bar series plotted on a category axis. It is a proportion between 0 and 1 which determines the size of the gap between the bars or columns within a single group along the axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "An array of depth options, starting from the leafs." ], "name": "depthOptions", "type": { "kind": "array", "type": "AgGroupedCategoryDepthOptions" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgGroupedCategoryAxisTickOptions", "optional": true }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true } ], "genericsMap": { "LabelType": "AgGroupedCategoryAxisLabelOptions", "CrosshairLabelType": "AgBaseCrosshairLabel" } }, "AgGroupedCategoryAxisThemeOptions": { "kind": "interface", "name": "AgGroupedCategoryAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped column/bar series plotted on a category axis. It is a proportion between 0 and 1 which determines the size of the gap between the bars or columns within a single group along the axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "An array of depth options, starting from the leafs." ], "name": "depthOptions", "type": { "kind": "array", "type": "AgGroupedCategoryDepthOptions" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgGroupedCategoryAxisTickOptions", "optional": true }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `top` positioned axes. Same configs apply here as one level above. For example, to rotate labels by 45 degrees in 'top' positioned axes one can use `top: { label: { rotation: 45 } } }`." ], "name": "top", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `right` positioned axes. Same configs apply here as one level above." ], "name": "right", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `bottom` positioned axes. Same configs apply here as one level above." ], "name": "bottom", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `left` positioned axes. Same configs apply here as one level above." ], "name": "left", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "name": "crossLines", "type": "AgCrossLineThemeOptions", "optional": true } ], "genericsMap": { "LabelType": "AgGroupedCategoryAxisLabelOptions", "CrosshairLabelType": "AgBaseCrosshairLabel", "T": "AgGroupedCategoryAxisOptions" } }, "AgGroupedCategoryAxisTickOptions": { "name": "AgGroupedCategoryAxisTickOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis ticks." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis ticks." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis ticks." ], "name": "stroke", "type": "CssColor", "optional": true } ] }, "AgGroupedCategoryDepthLabelOptions": { "name": "AgGroupedCategoryDepthLabelOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgGroupedCategoryDepthOptions": { "kind": "interface", "name": "AgGroupedCategoryDepthOptions", "members": [ { "kind": "member", "name": "label", "type": "AgGroupedCategoryDepthLabelOptions", "optional": true }, { "kind": "member", "name": "tick", "type": "AgGroupedCategoryDepthTickOptions", "optional": true } ] }, "AgGroupedCategoryDepthTickOptions": { "name": "AgGroupedCategoryDepthTickOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis ticks." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis ticks." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis ticks." ], "name": "stroke", "type": "CssColor", "optional": true } ] }, "AgGroupingValueType": { "kind": "interface", "name": "AgGroupingValueType", "members": [ { "kind": "member", "name": "value", "type": "ValueType", "optional": false }, { "kind": "member", "name": "groupPercentage", "type": "number", "optional": false } ] }, "AgHeatmapMiniChartSeriesOptions": { "kind": "interface", "name": "AgHeatmapMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Heatmap Series." ], "name": "type", "type": "'heatmap'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` configs) will be used to determine the cell colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual heatmap cells, based on the given parameters. If the current cell is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgHeatmapSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgHeatmapSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgHeatmapSeriesItemStylerParams": { "name": "AgHeatmapSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` configs) will be used to determine the cell colour." ], "name": "colorKey", "type": "string", "optional": true } ] }, "AgHeatmapSeriesLabelFormatterParams": { "name": "AgHeatmapSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` configs) will be used to determine the cell colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true } ] }, "AgHeatmapSeriesOptions": { "kind": "interface", "name": "AgHeatmapSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Heatmap Series." ], "name": "type", "type": "'heatmap'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into. For example, if the colour domain is `[-5, 5]` and `colorRange` is `['red', 'green']`, a `colorKey` value of `-5` will be assigned the 'red' colour, `5` - 'green' colour and `0` a blend of 'red' and 'green'." ], "name": "colorRange", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` configs) will be used to determine the cell colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Options for the label in each cell." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartAutoSizedSecondaryLabelOptions", "typeArguments": [ "TDatum", "AgHeatmapSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Minimum distance between the label text and the edges of the cell." ], "name": "itemPadding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the label." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "Vertical position of the label." ], "name": "verticalAlign", "type": "VerticalAlign", "optional": true }, { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual heatmap cells, based on the given parameters. If the current cell is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgHeatmapSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgHeatmapSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgHeatmapSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgHeatmapSeriesOptionsKeys": { "kind": "interface", "name": "AgHeatmapSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` configs) will be used to determine the cell colour." ], "name": "colorKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgHeatmapSeriesOptionsNames": { "kind": "interface", "name": "AgHeatmapSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgHeatmapSeriesStyle": { "name": "AgHeatmapSeriesStyle", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgHeatmapSeriesThemeOverrides": { "kind": "interface", "name": "AgHeatmapSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgHeatmapSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgHeatmapSeriesThemeableOptions": { "kind": "interface", "name": "AgHeatmapSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Options for the label in each cell." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartAutoSizedSecondaryLabelOptions", "typeArguments": [ "TDatum", "AgHeatmapSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Minimum distance between the label text and the edges of the cell." ], "name": "itemPadding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the label." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "Vertical position of the label." ], "name": "verticalAlign", "type": "VerticalAlign", "optional": true }, { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual heatmap cells, based on the given parameters. If the current cell is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgHeatmapSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgHeatmapSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgHeatmapSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgHeatmapSeriesTooltipRendererParams": { "name": "AgHeatmapSeriesTooltipRendererParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` configs) will be used to determine the cell colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgHierarchyChartOptions": { "kind": "interface", "name": "AgHierarchyChartOptions", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgHierarchySeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgHierarchySeriesOptions": { "kind": "typeAlias", "name": "AgHierarchySeriesOptions", "type": { "kind": "union", "type": [ "AgTreemapSeriesOptions", "AgSunburstSeriesOptions" ] } }, "AgHistogramBinDatum": { "kind": "interface", "name": "AgHistogramBinDatum", "members": [ { "kind": "member", "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": false }, { "kind": "member", "name": "aggregatedValue", "type": "number", "optional": false }, { "kind": "member", "name": "frequency", "type": "number", "optional": false }, { "kind": "member", "name": "domain", "type": { "kind": "tuple", "type": [ "number", "number" ] }, "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgHistogramMiniChartSeriesOptions": { "kind": "interface", "name": "AgHistogramMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Histogram Series." ], "name": "type", "type": "'histogram'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "If `true`, the aggregated `yKey` values will be represented using the area of the bar, instead of just the height." ], "name": "areaPlot", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Set the bin sizes explicitly.", "", "__Note:__ `bins` is ignored if `binCount` is also supplied." ], "name": "bins", "type": { "kind": "array", "type": { "kind": "tuple", "type": [ "number", "number" ] } }, "optional": true }, { "kind": "member", "docs": [ "The number of bins to try to split the x-axis into." ], "name": "binCount", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Dictates how the `yKey` values are aggregated within each bin." ], "name": "aggregation", "type": { "kind": "union", "type": [ "'count'", "'sum'", "'mean'" ] }, "optional": true, "defaultValue": "sum" }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgHistogramSeriesLabelFormatterParams": { "name": "AgHistogramSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true } ] }, "AgHistogramSeriesOptions": { "kind": "interface", "name": "AgHistogramSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Histogram Series." ], "name": "type", "type": "'histogram'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "If `true`, the aggregated `yKey` values will be represented using the area of the bar, instead of just the height." ], "name": "areaPlot", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Set the bin sizes explicitly.", "", "__Note:__ `bins` is ignored if `binCount` is also supplied." ], "name": "bins", "type": { "kind": "array", "type": { "kind": "tuple", "type": [ "number", "number" ] } }, "optional": true }, { "kind": "member", "docs": [ "The number of bins to try to split the x-axis into." ], "name": "binCount", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Dictates how the `yKey` values are aggregated within each bin." ], "name": "aggregation", "type": { "kind": "union", "type": [ "'count'", "'sum'", "'mean'" ] }, "optional": true, "defaultValue": "sum" }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on bars." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgHistogramSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgHistogramSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgHistogramSeriesOptionsKeys": { "kind": "interface", "name": "AgHistogramSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgHistogramSeriesOptionsNames": { "kind": "interface", "name": "AgHistogramSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgHistogramSeriesThemeOverrides": { "kind": "interface", "name": "AgHistogramSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgHistogramSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgHistogramSeriesThemeableOptions": { "kind": "interface", "name": "AgHistogramSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on bars." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgHistogramSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgHistogramSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgHistogramSeriesTooltipRendererParams": { "kind": "interface", "name": "AgHistogramSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "Range for x values." ], "name": "xRange", "type": { "kind": "tuple", "type": [ "number", "number" ] }, "optional": false }, { "kind": "member", "docs": [ "Number of values within xRange." ], "name": "frequency", "type": "number", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "yKey as specified on series options." ], "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": { "kind": "typeRef", "type": "AgHistogramBinDatum", "typeArguments": [ "TDatum" ] } } }, "AgHorizontalLineAnnotation": { "kind": "interface", "name": "AgHorizontalLineAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the horizontal-line annotation." ], "name": "type", "type": "'horizontal-line'", "optional": false }, { "kind": "member", "docs": [ "Position of the annotation specified in terms of the axis values." ], "name": "value", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "Configuration for the line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Configuration for the annotation axis label." ], "name": "axisLabel", "type": "AgAnnotationAxisLabel", "optional": true }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgIconName": { "kind": "typeAlias", "name": "AgIconName", "type": { "kind": "union", "type": [ "'align-center'", "'align-left'", "'align-right'", "'arrow-drawing'", "'arrow-down-drawing'", "'arrow-up-drawing'", "'callout-annotation'", "'candlestick-series'", "'close'", "'comment-annotation'", "'date-range-drawing'", "'date-price-range-drawing'", "'delete'", "'disjoint-channel-drawing'", "'drag-handle'", "'fill-color'", "'line-style-solid'", "'line-style-dashed'", "'line-style-dotted'", "'high-low-series'", "'hlc-series'", "'hollow-candlestick-series'", "'horizontal-line-drawing'", "'line-color'", "'line-series'", "'line-with-markers-series'", "'locked'", "'measurer-drawing'", "'note-annotation'", "'ohlc-series'", "'pan-end'", "'pan-left'", "'pan-right'", "'pan-start'", "'parallel-channel-drawing'", "'position-bottom'", "'position-center'", "'position-top'", "'price-label-annotation'", "'price-range-drawing'", "'reset'", "'settings'", "'step-line-series'", "'text-annotation'", "'trend-line-drawing'", "'fibonacci-retracement-drawing'", "'fibonacci-retracement-trend-based-drawing'", "'unlocked'", "'vertical-line-drawing'", "'zoom-in'", "'zoom-out'" ] } }, "AgInitialStateChartType": { "kind": "typeAlias", "name": "AgInitialStateChartType", "type": "AgPriceVolumeChartType" }, "AgInitialStateLegendOptions": { "kind": "interface", "name": "AgInitialStateLegendOptions", "members": [ { "kind": "member", "docs": [ "Whether the legend item is currently enabled or not." ], "name": "visible", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Series or item id" ], "name": "seriesId", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Legend item id - usually yKey value for cartesian series." ], "name": "itemId", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true } ] }, "AgInitialStateOptions": { "kind": "interface", "name": "AgInitialStateOptions", "members": [ { "kind": "member", "docs": [ "The initial set of annotations to display on the chart." ], "name": "annotations", "type": { "kind": "array", "type": "AgAnnotation" }, "optional": true }, { "kind": "member", "name": "chartType", "type": "AgInitialStateChartType", "optional": true }, { "kind": "member", "docs": [ "The initial zoom state." ], "name": "zoom", "type": "AgInitialStateZoomOptions", "optional": true }, { "kind": "member", "docs": [ "The initial legend state." ], "name": "legend", "type": { "kind": "array", "type": "AgInitialStateLegendOptions" }, "optional": true } ] }, "AgInitialStateThemeableOptions": { "kind": "interface", "name": "AgInitialStateThemeableOptions", "members": [ { "kind": "member", "name": "zoom", "type": "AgInitialStateZoomOptions", "optional": true }, { "kind": "member", "name": "legend", "type": { "kind": "array", "type": "AgInitialStateLegendOptions" }, "optional": true } ] }, "AgInitialStateZoomOptions": { "kind": "interface", "name": "AgInitialStateZoomOptions", "members": [ { "kind": "member", "name": "rangeX", "type": "AgInitialStateZoomRange", "optional": true }, { "kind": "member", "name": "rangeY", "type": "AgInitialStateZoomRange", "optional": true }, { "kind": "member", "name": "ratioX", "type": "AgInitialStateZoomRatio", "optional": true }, { "kind": "member", "name": "ratioY", "type": "AgInitialStateZoomRatio", "optional": true }, { "kind": "member", "docs": [ "Axes that are zoomed by the auto scaling functionality." ], "name": "autoScaledAxes", "type": "AgAutoScaledAxes", "optional": true } ] }, "AgInitialStateZoomRange": { "kind": "interface", "name": "AgInitialStateZoomRange", "members": [ { "kind": "member", "name": "start", "type": { "kind": "union", "type": [ "AgStateSerializableDate", "number" ] }, "optional": true }, { "kind": "member", "name": "end", "type": { "kind": "union", "type": [ "AgStateSerializableDate", "number" ] }, "optional": true } ] }, "AgInitialStateZoomRatio": { "kind": "interface", "name": "AgInitialStateZoomRatio", "members": [ { "kind": "member", "name": "start", "type": "Ratio", "optional": true }, { "kind": "member", "name": "end", "type": "Ratio", "optional": true } ] }, "AgInterpolationType": { "kind": "typeAlias", "name": "AgInterpolationType", "type": { "kind": "union", "type": [ "AgLineLinearType", "AgLineSmoothType", "AgLineStepType" ] } }, "AgKeyboardOptions": { "kind": "interface", "name": "AgKeyboardOptions", "members": [ { "kind": "member", "docs": [ "Toggles the keyboard navigation feature." ], "name": "enabled", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Allows setting the tabIndex of the chart canvas." ], "name": "tabIndex", "type": "number", "optional": true, "defaultValue": "0" } ] }, "AgLineAnnotation": { "kind": "interface", "name": "AgLineAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the trend line annotation." ], "name": "type", "type": "'line'", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgLineAnnotationStyles": { "kind": "interface", "name": "AgLineAnnotationStyles", "members": [ { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgLineAnnotationText": { "kind": "interface", "name": "AgLineAnnotationText", "members": [ { "kind": "member", "name": "label", "type": "string", "optional": true }, { "kind": "member", "name": "position", "type": { "kind": "union", "type": [ "'top'", "'center'", "'bottom'" ] }, "optional": true }, { "kind": "member", "name": "alignment", "type": { "kind": "union", "type": [ "'left'", "'center'", "'right'" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgLineAnnotationTextOptions": { "kind": "interface", "name": "AgLineAnnotationTextOptions", "members": [ { "kind": "member", "name": "position", "type": { "kind": "union", "type": [ "'top'", "'center'", "'bottom'" ] }, "optional": true }, { "kind": "member", "name": "alignment", "type": { "kind": "union", "type": [ "'left'", "'center'", "'right'" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgLineLinearType": { "kind": "interface", "name": "AgLineLinearType", "members": [ { "kind": "member", "name": "type", "type": "'linear'", "optional": false } ] }, "AgLineMiniChartSeriesOptions": { "kind": "interface", "name": "AgLineMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Line Series." ], "name": "type", "type": "'line'", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The number to normalise the line stacks to. For example, if `normalizedTo` is set to `100`, the stacks will all be scaled proportionally so that their total height is always 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the lines should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgLineSeriesMarkerItemStylerParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLineSeriesLabelFormatterParams": { "name": "AgLineSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true } ] }, "AgLineSeriesMarkerItemStylerParams": { "kind": "interface", "name": "AgLineSeriesMarkerItemStylerParams", "members": [ { "kind": "member", "docs": [ "The x value of the datum." ], "name": "xValue", "type": "any", "optional": false }, { "kind": "member", "docs": [ "The y value of the datum." ], "name": "yValue", "type": "any", "optional": false }, { "kind": "member", "docs": [ "Whether the item's x value is the first in the data domain." ], "name": "first", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's x value is the last in the data domain." ], "name": "last", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's y value is the lowest in the data." ], "name": "min", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Whether the item's y value is the highest in the data." ], "name": "max", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false } ] }, "AgLineSeriesOptions": { "kind": "interface", "name": "AgLineSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Line Series." ], "name": "type", "type": "'line'", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration for the Error Bars." ], "name": "errorBar", "type": { "kind": "typeRef", "type": "AgErrorBarOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The number to normalise the line stacks to. For example, if `normalizedTo` is set to `100`, the stacks will all be scaled proportionally so that their total height is always 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the lines should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgLineSeriesMarkerItemStylerParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgLineSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgLineSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgLineSeriesOptionsKeys": { "kind": "interface", "name": "AgLineSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "any" } }, "AgLineSeriesOptionsNames": { "kind": "interface", "name": "AgLineSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLineSeriesThemeOverrides": { "kind": "interface", "name": "AgLineSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgLineSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLineSeriesThemeableOptions": { "kind": "interface", "name": "AgLineSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgLineSeriesMarkerItemStylerParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgLineSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgLineSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Error Bars." ], "name": "errorBar", "type": "AgErrorBarThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgLineSeriesTooltipRendererParams": { "kind": "interface", "name": "AgLineSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "yKey as specified on series options." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the x axis data." ], "name": "xLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The x-axis lower bound error value." ], "name": "xLowerValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the x axis. This is the value to use in tooltips or labels." ], "name": "xLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the x axis data." ], "name": "xUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The x-axis upper bound error value." ], "name": "xUpperValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the x axis. This is the value to use in tooltips or labels." ], "name": "xUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the y axis data." ], "name": "yLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The y-axis lower bound error value." ], "name": "yLowerValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the y axis. This is the value to use in tooltips or labels." ], "name": "yLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the y axis data." ], "name": "yUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The y-axis upper bound error value." ], "name": "yUpperValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the y axis. This is the value to use in tooltips or labels." ], "name": "yUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgLineSmoothType": { "kind": "interface", "name": "AgLineSmoothType", "members": [ { "kind": "member", "name": "type", "type": "'smooth'", "optional": false }, { "kind": "member", "name": "tension", "type": "Ratio", "optional": true } ] }, "AgLineSparklinePreset": { "kind": "interface", "name": "AgLineSparklinePreset", "members": [ { "kind": "member", "docs": [ "Configuration for the Line Series." ], "name": "type", "type": "'line'", "optional": true }, { "kind": "member", "docs": [ "Context to use for tooltips." ], "name": "context", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Crosshair configurations." ], "name": "crosshair", "type": "AgSparklineCrosshairOptions", "optional": true }, { "kind": "member", "docs": [ "y-axis configurations." ], "name": "axis", "type": "AgSparklineAxisOptions", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Tooltip configuration." ], "name": "tooltip", "type": "AgSparklineTooltip", "optional": true }, { "kind": "member", "name": "xKey", "type": "string", "optional": true }, { "kind": "member", "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The number to normalise the line stacks to. For example, if `normalizedTo` is set to `100`, the stacks will all be scaled proportionally so that their total height is always 100." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgLineSeriesMarkerItemStylerParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgLineSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLineStepType": { "kind": "interface", "name": "AgLineStepType", "members": [ { "kind": "member", "name": "type", "type": "'step'", "optional": false }, { "kind": "member", "name": "position", "type": { "kind": "union", "type": [ "'start'", "'middle'", "'end'" ] }, "optional": true } ] }, "AgLinearGaugeBarStyle": { "kind": "interface", "name": "AgLinearGaugeBarStyle", "members": [ { "kind": "member", "docs": [ "Whether the bar should be shown." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Width of the bar, or the height if `horizontal` is true. Defaults to the gauge thickness." ], "name": "thickness", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Thickness of the bar in proportion to the gauge thickness. Ignored if `thickness` is set." ], "name": "thicknessRatio", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for two or more colours, and the values they are rendered at." ], "name": "fills", "type": { "kind": "array", "type": "AgGaugeColorStop" }, "optional": true }, { "kind": "member", "docs": [ "Configuration the fills should be rendered." ], "name": "fillMode", "type": "AgGaugeFillMode", "optional": true, "defaultValue": "continuous" }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgLinearGaugeItemStylerParams": { "kind": "interface", "name": "AgLinearGaugeItemStylerParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false } ], "genericsMap": { "TDatum": "GaugeDatum" } }, "AgLinearGaugeLabelFormatterParams": { "kind": "interface", "name": "AgLinearGaugeLabelFormatterParams", "members": [] }, "AgLinearGaugeLabelOptions": { "kind": "interface", "name": "AgLinearGaugeLabelOptions", "members": [ { "kind": "member", "docs": [ "Text to always display." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Avoid label collisions with the bar and/or scale." ], "name": "avoidCollisions", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Placement of the label." ], "name": "placement", "type": "AgLinearGaugeLabelPlacement", "optional": true }, { "kind": "member", "docs": [ "Line height to use for the label." ], "name": "lineHeight", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "If the label does not fit in the container, setting this will allow the label to pick a font size between its normal `fontSize` and `minimumFontSize` to fit within the container." ], "name": "minimumFontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for labels.", "- `'always'` will always wrap text to fit within the tile.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tile dimensions, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" }, { "kind": "member", "docs": [ "Adjusts the behaviour of labels when they overflow", "- `'ellipsis'` will truncate the text to fit, appending an ellipsis (...)", "- `'hide'` only displays the label if it completely fits within its bounds, and removes it if it would overflow" ], "name": "overflowStrategy", "type": "OverflowStrategy", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "genericsMap": { "TDatum": "never", "TParams": "AgLinearGaugeLabelFormatterParams" } }, "AgLinearGaugeLabelPlacement": { "kind": "typeAlias", "name": "AgLinearGaugeLabelPlacement", "type": { "kind": "union", "type": [ "'inside-start'", "'outside-start'", "'inside-end'", "'outside-end'", "'inside-center'", "'bar-inside'", "'bar-inside-end'", "'bar-outside-end'", "'bar-end'" ] } }, "AgLinearGaugeMarkerShape": { "kind": "typeAlias", "name": "AgLinearGaugeMarkerShape", "type": { "kind": "union", "type": [ "AgMarkerShape", "'line'" ] } }, "AgLinearGaugeOptions": { "name": "AgLinearGaugeOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "Configuration for the Linear Gauge." ], "name": "type", "type": "'linear-gauge'", "optional": false }, { "kind": "member", "docs": [ "Value of the Linear Gauge." ], "name": "value", "type": "number", "optional": false }, { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Scale of the Linear Gauge." ], "name": "scale", "type": "AgLinearGaugeScale", "optional": true }, { "kind": "member", "docs": [ "Configuration for the targets." ], "name": "targets", "type": { "kind": "array", "type": "AgLinearGaugeTarget" }, "optional": true }, { "kind": "member", "docs": [ "Direction to display the gauge in." ], "name": "direction", "type": "Direction", "optional": true }, { "kind": "member", "docs": [ "Width of the gauge, or the height if `direction` is `horizontal`." ], "name": "thickness", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgLinearGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgLinearGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLinearGaugePreset": { "kind": "interface", "name": "AgLinearGaugePreset", "members": [ { "kind": "member", "docs": [ "Configuration for the Linear Gauge." ], "name": "type", "type": "'linear-gauge'", "optional": false }, { "kind": "member", "docs": [ "Value of the Linear Gauge." ], "name": "value", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Scale of the Linear Gauge." ], "name": "scale", "type": "AgLinearGaugeScale", "optional": true }, { "kind": "member", "docs": [ "Configuration for the targets." ], "name": "targets", "type": { "kind": "array", "type": "AgLinearGaugeTarget" }, "optional": true }, { "kind": "member", "docs": [ "Direction to display the gauge in." ], "name": "direction", "type": "Direction", "optional": true }, { "kind": "member", "docs": [ "Width of the gauge, or the height if `direction` is `horizontal`." ], "name": "thickness", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgLinearGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgLinearGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgLinearGaugeTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "GaugeDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLinearGaugeScale": { "kind": "interface", "name": "AgLinearGaugeScale", "members": [ { "kind": "member", "docs": [ "Maximum value of the scale. Any values exceeding this number will be clipped to this maximum." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Minimum value of the scale. Any values exceeding this number will be clipped to this minimum." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the scale labels." ], "name": "label", "type": "AgLinearGaugeScaleLabel", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ticks interval." ], "name": "interval", "type": "AgLinearGaugeScaleInterval", "optional": true }, { "kind": "member", "docs": [ "Configuration for two or more colours, and the values they are rendered at." ], "name": "fills", "type": { "kind": "array", "type": "AgGaugeColorStop" }, "optional": true }, { "kind": "member", "docs": [ "Configuration the fills should be rendered." ], "name": "fillMode", "type": "AgGaugeFillMode", "optional": true, "defaultValue": "continuous" }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgLinearGaugeScaleInterval": { "kind": "interface", "name": "AgLinearGaugeScaleInterval", "members": [ { "kind": "member", "docs": [ "Array of values in scale units for specified intervals along the scale. The values in this array must be compatible with the scale type." ], "name": "values", "type": { "kind": "array", "type": "number" }, "optional": true }, { "kind": "member", "docs": [ "The scale interval. Expressed in the units of the scale. If the configured interval results in too many items given the chart size, it will be ignored." ], "name": "step", "type": "number", "optional": true } ] }, "AgLinearGaugeScaleLabel": { "kind": "interface", "name": "AgLinearGaugeScaleLabel", "members": [ { "kind": "member", "docs": [ "Placement of labels" ], "name": "placement", "type": { "kind": "union", "type": [ "'before'", "'after'" ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `false` to hide the scale labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the scale label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The rotation of the scale labels in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid scale label collision by automatically reducing the number of ticks displayed. If set to `false`, scale labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the scale labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to render scale labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true } ] }, "AgLinearGaugeStyle": { "kind": "interface", "name": "AgLinearGaugeStyle", "members": [], "genericsMap": { "TDatum": "any" } }, "AgLinearGaugeTarget": { "kind": "interface", "name": "AgLinearGaugeTarget", "members": [ { "kind": "member", "docs": [ "Value to use to position the target" ], "name": "value", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Text to use for the target label." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgLinearGaugeMarkerShape", "optional": true }, { "kind": "member", "docs": [ "Placement of target." ], "name": "placement", "type": "AgLinearGaugeTargetPlacement", "optional": true }, { "kind": "member", "docs": [ "Spacing of the target. Ignored when placement is 'middle'." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Size of the target." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Rotation of the target, in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgLinearGaugeTargetPlacement": { "kind": "typeAlias", "name": "AgLinearGaugeTargetPlacement", "type": { "kind": "union", "type": [ "'before'", "'after'", "'middle'" ] } }, "AgLinearGaugeTargetTheme": { "kind": "interface", "name": "AgLinearGaugeTargetTheme", "members": [ { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgLinearGaugeMarkerShape", "optional": true }, { "kind": "member", "docs": [ "Placement of target." ], "name": "placement", "type": "AgLinearGaugeTargetPlacement", "optional": true }, { "kind": "member", "docs": [ "Spacing of the target. Ignored when placement is 'middle'." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Size of the target." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Rotation of the target, in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgLinearGaugeTheme": { "name": "AgLinearGaugeTheme", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Direction to display the gauge in." ], "name": "direction", "type": "Direction", "optional": true }, { "kind": "member", "docs": [ "Width of the gauge, or the height if `direction` is `horizontal`." ], "name": "thickness", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgLinearGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgLinearGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLinearGaugeThemeOverrides": { "kind": "interface", "name": "AgLinearGaugeThemeOverrides", "members": [ { "kind": "member", "name": "targets", "type": "AgLinearGaugeTargetTheme", "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Direction to display the gauge in." ], "name": "direction", "type": "Direction", "optional": true }, { "kind": "member", "docs": [ "Width of the gauge, or the height if `direction` is `horizontal`." ], "name": "thickness", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgLinearGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgLinearGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLinearGaugeThemeableOptions": { "kind": "interface", "name": "AgLinearGaugeThemeableOptions", "members": [ { "kind": "member", "docs": [ "Direction to display the gauge in." ], "name": "direction", "type": "Direction", "optional": true }, { "kind": "member", "docs": [ "Width of the gauge, or the height if `direction` is `horizontal`." ], "name": "thickness", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgLinearGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgLinearGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgLinearGaugeTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "GaugeDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgLinearGaugeTooltipRendererParams": { "kind": "interface", "name": "AgLinearGaugeTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "Value of the Gauge" ], "name": "value", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgLocaleOptions": { "kind": "interface", "name": "AgLocaleOptions", "members": [ { "kind": "member", "docs": [ "A record of locale texts keyed by id." ], "name": "localeText", "type": { "kind": "typeRef", "type": "Record", "typeArguments": [ "string", "string" ] }, "optional": true }, { "kind": "member", "docs": [ "Formatter that generates the text displayed to the user." ], "name": "getLocaleText", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "MessageFormatterParams" ] }, "optional": true } ] }, "AgLocaleThemeableOptions": { "kind": "interface", "name": "AgLocaleThemeableOptions", "members": [ { "kind": "member", "docs": [ "A record of locale texts keyed by id." ], "name": "localeText", "type": { "kind": "typeRef", "type": "Record", "typeArguments": [ "string", "string" ] }, "optional": true }, { "kind": "member", "docs": [ "Formatter that generates the text displayed to the user." ], "name": "getLocaleText", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "MessageFormatterParams" ] }, "optional": true } ] }, "AgLogAxisOptions": { "kind": "interface", "name": "AgLogAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'log'", "optional": false }, { "kind": "member", "docs": [ "The base of the logarithm used." ], "name": "base", "type": "number", "optional": true }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgCartesianCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": "number", "TInterval": "number" } }, "AgLogAxisThemeOptions": { "kind": "interface", "name": "AgLogAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "The base of the logarithm used." ], "name": "base", "type": "number", "optional": true }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `top` positioned axes. Same configs apply here as one level above. For example, to rotate labels by 45 degrees in 'top' positioned axes one can use `top: { label: { rotation: 45 } } }`." ], "name": "top", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `right` positioned axes. Same configs apply here as one level above." ], "name": "right", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `bottom` positioned axes. Same configs apply here as one level above." ], "name": "bottom", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `left` positioned axes. Same configs apply here as one level above." ], "name": "left", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "name": "crossLines", "type": "AgCrossLineThemeOptions", "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": "number", "TInterval": "number", "T": "AgLogAxisOptions" } }, "AgMapLineBackgroundOptions": { "kind": "interface", "name": "AgMapLineBackgroundOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Map Shape Background." ], "name": "type", "type": "'map-line-background'", "optional": false }, { "kind": "member", "docs": [ "GeoJSON data." ], "name": "topology", "type": "GeoJSON", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke of the line." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgMapLineBackgroundThemeOverrides": { "kind": "interface", "name": "AgMapLineBackgroundThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgMapLineBackgroundThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgMapLineBackgroundThemeableOptions": { "kind": "interface", "name": "AgMapLineBackgroundThemeableOptions", "members": [ { "kind": "member", "docs": [ "The colour for the stroke of the line." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgMapLineSeriesHighlightStyle": { "name": "AgMapLineSeriesHighlightStyle", "typeParams": [ { "kind": "typeParam", "name": "_TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "Highlight style used for an individual item within a series." ], "name": "item", "type": "AgSeriesHighlightMarkerStyle", "optional": true }, { "kind": "member", "docs": [ "Highlight style used for whole series when a series or legend item is hovered." ], "name": "series", "type": "AgSeriesHighlightSeriesStyle", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgMapLineSeriesItemStylerParams": { "name": "AgMapLineSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the width of the stroke." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the stroke." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels on top of lines." ], "name": "labelKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgMapLineSeriesLabel": { "name": "AgMapLineSeriesLabel", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "genericsMap": { "TParams": "AgMapLineSeriesLabelFormatterParams" } }, "AgMapLineSeriesLabelFormatterParams": { "name": "AgMapLineSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the width of the stroke." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the stroke." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels on top of lines." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ] }, "AgMapLineSeriesOptions": { "kind": "interface", "name": "AgMapLineSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Map Line Series." ], "name": "type", "type": "'map-line'", "optional": false }, { "kind": "member", "docs": [ "GeoJSON data." ], "name": "topology", "type": "GeoJSON", "optional": true }, { "kind": "member", "docs": [ "The property to reference in the topology to match up with data." ], "name": "topologyIdKey", "type": "string", "optional": true, "defaultValue": "name" }, { "kind": "member", "docs": [ "The title to use for the series." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The text to display in the legend for this series. If multiple series share this value, they will be merged for the legend toggle behaviour." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the width of the stroke." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the stroke." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels on top of lines." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Determines the largest width a stroke can be in pixels." ], "name": "maxStrokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Explicitly specifies the extent of the domain for series `sizeKey`." ], "name": "sizeDomain", "type": { "kind": "array", "type": "number" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of the line." ], "name": "label", "type": { "kind": "typeRef", "type": "AgMapLineSeriesLabel", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgMapLineSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular Map line based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgMapLineSeriesItemStylerParams", "AgMapLineSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgMapLineSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapLineSeriesOptionsKeys": { "kind": "interface", "name": "AgMapLineSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the width of the stroke." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the stroke." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels on top of lines." ], "name": "labelKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapLineSeriesOptionsNames": { "kind": "interface", "name": "AgMapLineSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapLineSeriesStyle": { "name": "AgMapLineSeriesStyle", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgMapLineSeriesThemeOverrides": { "kind": "interface", "name": "AgMapLineSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgMapLineSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgMapLineSeriesThemeableOptions": { "kind": "interface", "name": "AgMapLineSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Determines the largest width a stroke can be in pixels." ], "name": "maxStrokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Explicitly specifies the extent of the domain for series `sizeKey`." ], "name": "sizeDomain", "type": { "kind": "array", "type": "number" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of the line." ], "name": "label", "type": { "kind": "typeRef", "type": "AgMapLineSeriesLabel", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgMapLineSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular Map line based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgMapLineSeriesItemStylerParams", "AgMapLineSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgMapLineSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapLineSeriesTooltipRendererParams": { "name": "AgMapLineSeriesTooltipRendererParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the width of the stroke." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the stroke." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels on top of lines." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapMarkerSeriesHighlightStyle": { "name": "AgMapMarkerSeriesHighlightStyle", "typeParams": [ { "kind": "typeParam", "name": "_TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "Highlight style used for an individual item within a series." ], "name": "item", "type": "AgSeriesHighlightMarkerStyle", "optional": true }, { "kind": "member", "docs": [ "Highlight style used for whole series when a series or legend item is hovered." ], "name": "series", "type": "AgSeriesHighlightSeriesStyle", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgMapMarkerSeriesItemStylerParams": { "name": "AgMapMarkerSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": false }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve latitude values from the data, used to control the position of the markers." ], "name": "latitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve longitude values from the data, used to control the position of the markers." ], "name": "longitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the markers." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgMapMarkerSeriesLabel": { "kind": "interface", "name": "AgMapMarkerSeriesLabel", "members": [ { "kind": "member", "docs": [ "Placement of label in relation to the marker." ], "name": "placement", "type": "LabelPlacement", "optional": true, "defaultValue": "bottom" }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TParams": "AgMapMarkerSeriesLabelFormatterParams" } }, "AgMapMarkerSeriesLabelFormatterParams": { "name": "AgMapMarkerSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve latitude values from the data, used to control the position of the markers." ], "name": "latitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve longitude values from the data, used to control the position of the markers." ], "name": "longitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the markers." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the latitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "latitudeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the longitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "longitudeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ] }, "AgMapMarkerSeriesOptions": { "kind": "interface", "name": "AgMapMarkerSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Map Marker Series." ], "name": "type", "type": "'map-marker'", "optional": false }, { "kind": "member", "docs": [ "GeoJSON data." ], "name": "topology", "type": "GeoJSON", "optional": true }, { "kind": "member", "docs": [ "The property to reference in the topology to match up with data." ], "name": "topologyIdKey", "type": "string", "optional": true, "defaultValue": "name" }, { "kind": "member", "docs": [ "The title to use for the series." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The text to display in the legend for this series. If multiple series share this value, they will be merged for the legend toggle behaviour." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve latitude values from the data, used to control the position of the markers." ], "name": "latitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve longitude values from the data, used to control the position of the markers." ], "name": "longitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the markers." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the latitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "latitudeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the longitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "longitudeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Determines the largest size a marker can be in pixels." ], "name": "maxSize", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Explicitly specifies the extent of the domain for series `sizeKey`." ], "name": "sizeDomain", "type": { "kind": "tuple", "type": [ "number", "number" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into." ], "name": "colorRange", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgMapMarkerSeriesLabel", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgMapMarkerSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular Map marker based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgMapMarkerSeriesItemStylerParams", "AgMapMarkerSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgMapMarkerSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapMarkerSeriesOptionsKeys": { "kind": "interface", "name": "AgMapMarkerSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve latitude values from the data, used to control the position of the markers." ], "name": "latitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve longitude values from the data, used to control the position of the markers." ], "name": "longitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the markers." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapMarkerSeriesOptionsNames": { "kind": "interface", "name": "AgMapMarkerSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the latitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "latitudeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the longitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "longitudeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapMarkerSeriesStyle": { "kind": "interface", "name": "AgMapMarkerSeriesStyle", "members": [ { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapMarkerSeriesThemeOverrides": { "kind": "interface", "name": "AgMapMarkerSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgMapMarkerSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgMapMarkerSeriesThemeableOptions": { "kind": "interface", "name": "AgMapMarkerSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Determines the largest size a marker can be in pixels." ], "name": "maxSize", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Explicitly specifies the extent of the domain for series `sizeKey`." ], "name": "sizeDomain", "type": { "kind": "tuple", "type": [ "number", "number" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into." ], "name": "colorRange", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgMapMarkerSeriesLabel", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgMapMarkerSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular Map marker based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgMapMarkerSeriesItemStylerParams", "AgMapMarkerSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgMapMarkerSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapMarkerSeriesTooltipRendererParams": { "kind": "interface", "name": "AgMapMarkerSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve latitude values from the data, used to control the position of the markers." ], "name": "latitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve longitude values from the data, used to control the position of the markers." ], "name": "longitudeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the colour of the markers." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the latitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "latitudeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the longitude values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "longitudeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapShapeBackgroundOptions": { "kind": "interface", "name": "AgMapShapeBackgroundOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Map Shape Background." ], "name": "type", "type": "'map-shape-background'", "optional": false }, { "kind": "member", "docs": [ "GeoJSON data." ], "name": "topology", "type": "GeoJSON", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgMapShapeBackgroundThemeOverrides": { "kind": "interface", "name": "AgMapShapeBackgroundThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgMapShapeBackgroundThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgMapShapeBackgroundThemeableOptions": { "kind": "interface", "name": "AgMapShapeBackgroundThemeableOptions", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgMapShapeSeriesHighlightStyle": { "name": "AgMapShapeSeriesHighlightStyle", "typeParams": [ { "kind": "typeParam", "name": "_TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "Highlight style used for an individual item within a series." ], "name": "item", "type": "AgSeriesHighlightMarkerStyle", "optional": true }, { "kind": "member", "docs": [ "Highlight style used for whole series when a series or legend item is hovered." ], "name": "series", "type": "AgSeriesHighlightSeriesStyle", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgMapShapeSeriesItemStylerParams": { "name": "AgMapShapeSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels inside shapes." ], "name": "labelKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgMapShapeSeriesLabelFormatterParams": { "name": "AgMapShapeSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels inside shapes." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ] }, "AgMapShapeSeriesOptions": { "kind": "interface", "name": "AgMapShapeSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Map Shape Series." ], "name": "type", "type": "'map-shape'", "optional": false }, { "kind": "member", "docs": [ "GeoJSON data." ], "name": "topology", "type": "GeoJSON", "optional": true }, { "kind": "member", "docs": [ "The property to reference in the topology to match up with data." ], "name": "topologyIdKey", "type": "string", "optional": true, "defaultValue": "name" }, { "kind": "member", "docs": [ "The title to use for the series." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The text to display in the legend for this series. If multiple series share this value, they will be merged for the legend toggle behaviour." ], "name": "legendItemName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels inside shapes." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into." ], "name": "colorRange", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartAutoSizedSecondaryLabelOptions", "typeArguments": [ "TDatum", "AgMapShapeSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgMapShapeSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular Map shape based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgMapShapeSeriesItemStylerParams", "AgMapShapeSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgMapShapeSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapShapeSeriesOptionsKeys": { "kind": "interface", "name": "AgMapShapeSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels inside shapes." ], "name": "labelKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapShapeSeriesOptionsNames": { "kind": "interface", "name": "AgMapShapeSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapShapeSeriesStyle": { "name": "AgMapShapeSeriesStyle", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgMapShapeSeriesThemeOverrides": { "kind": "interface", "name": "AgMapShapeSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgMapShapeSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgMapShapeSeriesThemeableOptions": { "kind": "interface", "name": "AgMapShapeSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into." ], "name": "colorRange", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartAutoSizedSecondaryLabelOptions", "typeArguments": [ "TDatum", "AgMapShapeSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgMapShapeSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular Map shape based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgMapShapeSeriesItemStylerParams", "AgMapShapeSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgMapShapeSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMapShapeSeriesTooltipRendererParams": { "kind": "interface", "name": "AgMapShapeSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the id value." ], "name": "idKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels inside shapes." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the id-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "idName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgMarkerShape": { "kind": "typeAlias", "name": "AgMarkerShape", "type": { "kind": "union", "type": [ "'circle'", "'cross'", "'diamond'", "'heart'", "'plus'", "'pin'", "'square'", "'star'", "'triangle'", "AgMarkerShapeFn" ] } }, "AgMarkerShapeFn": { "kind": "typeAlias", "name": "AgMarkerShapeFn", "type": { "kind": "function", "params": [ { "kind": "param", "name": "params", "type": "AgMarkerShapeFnParams" } ], "returnType": "void" } }, "AgMarkerShapeFnParams": { "kind": "interface", "name": "AgMarkerShapeFnParams", "members": [ { "kind": "member", "name": "path", "type": "AgPath", "optional": false }, { "kind": "member", "name": "x", "type": "number", "optional": false }, { "kind": "member", "name": "y", "type": "number", "optional": false }, { "kind": "member", "name": "size", "type": "number", "optional": false }, { "kind": "member", "name": "pixelRatio", "type": "number", "optional": false } ] }, "AgMeasurerAnnotation": { "kind": "interface", "name": "AgMeasurerAnnotation", "members": [ { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Configuration for the statistics." ], "name": "statistics", "type": "AgMeasurerAnnotationStatistics", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgMeasurerAnnotationStatistics": { "kind": "interface", "name": "AgMeasurerAnnotationStatistics", "members": [ { "kind": "member", "name": "divider", "type": "StrokeOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgMeasurerAnnotationStyles": { "kind": "interface", "name": "AgMeasurerAnnotationStyles", "members": [ { "kind": "member", "name": "background", "type": "FillOptions", "optional": true }, { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "name": "statistics", "type": "AgMeasurerAnnotationStatistics", "optional": true }, { "kind": "member", "name": "text", "type": "AgLineAnnotationTextOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true } ] }, "AgMiniChartSeriesOptions": { "kind": "typeAlias", "name": "AgMiniChartSeriesOptions", "type": { "kind": "union", "type": [ "AgLineMiniChartSeriesOptions", "AgScatterMiniChartSeriesOptions", "AgBubbleMiniChartSeriesOptions", "AgAreaMiniChartSeriesOptions", "AgBarMiniChartSeriesOptions", "AgBoxPlotMiniChartSeriesOptions", "AgHistogramMiniChartSeriesOptions", "AgHeatmapMiniChartSeriesOptions", "AgWaterfallMiniChartSeriesOptions", "AgRangeBarMiniChartSeriesOptions", "AgRangeAreaMiniChartSeriesOptions", "AgCandlestickMiniChartSeriesOptions", "AgOhlcMiniChartSeriesOptions" ] } }, "AgNavigatorHandleOptions": { "kind": "interface", "name": "AgNavigatorHandleOptions", "members": [ { "kind": "member", "docs": [ "The fill colour used by the handle." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The stroke colour used by the handle." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The stroke width used by the handle." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The width of the handle." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the handle." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The corner radius of the handle." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to enable the grip dots." ], "name": "grip", "type": "boolean", "optional": true } ] }, "AgNavigatorMaskOptions": { "kind": "interface", "name": "AgNavigatorMaskOptions", "members": [ { "kind": "member", "docs": [ "The fill colour used by the mask." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the mask's fill in the `[0, 1]` interval, where `0` is effectively no masking." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The stroke colour used by the mask." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The stroke width used by the mask." ], "name": "strokeWidth", "type": "PixelSize", "optional": true } ] }, "AgNavigatorMiniChartIntervalOptions": { "kind": "interface", "name": "AgNavigatorMiniChartIntervalOptions", "members": [ { "kind": "member", "docs": [ "Maximum gap in pixels between labels." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Maximum gap in pixels between labels." ], "name": "maxSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Array of values in axis units to display as labels along the axis. The values in this array must be compatible with the axis type." ], "name": "values", "type": { "kind": "array", "type": "any" }, "optional": true }, { "kind": "member", "docs": [ "The step value between labels, specified as a number or time interval. If the configured interval results in too many labels given the chart size, it will be ignored." ], "name": "step", "type": "number", "optional": true } ] }, "AgNavigatorMiniChartLabelOptions": { "kind": "interface", "name": "AgNavigatorMiniChartLabelOptions", "members": [ { "kind": "member", "docs": [ "Configuration for interval between the Mini Chart's axis labels." ], "name": "interval", "type": "AgNavigatorMiniChartIntervalOptions", "optional": true }, { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis labels and the Mini Chart." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of labels displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between intervals; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true } ] }, "AgNavigatorMiniChartOptions": { "kind": "interface", "name": "AgNavigatorMiniChartOptions", "members": [ { "kind": "member", "docs": [ "Whether to show a Mini Chart in the Navigator." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Override series used in Mini Chart." ], "name": "series", "type": { "kind": "array", "type": "AgMiniChartSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Mini Chart's axis labels." ], "name": "label", "type": "AgNavigatorMiniChartLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the padding inside the Mini Chart." ], "name": "padding", "type": "AgNavigatorMiniChartPadding", "optional": true } ] }, "AgNavigatorMiniChartPadding": { "kind": "interface", "name": "AgNavigatorMiniChartPadding", "members": [ { "kind": "member", "docs": [ "Padding between the top edge of the Navigator and the Mini Chart series." ], "name": "top", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Padding between the bottom edge of the Navigator and the Mini Chart series." ], "name": "bottom", "type": "number", "optional": true } ] }, "AgNavigatorOptions": { "kind": "interface", "name": "AgNavigatorOptions", "members": [ { "kind": "member", "docs": [ "Whether to show the Navigator." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The height of the Navigator." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The corner radius used by the Navigator." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "The distance between the Navigator and the bottom axis of the chart." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator's visible range mask." ], "name": "mask", "type": "AgNavigatorMaskOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator's left handle." ], "name": "minHandle", "type": "AgNavigatorHandleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator's right handle." ], "name": "maxHandle", "type": "AgNavigatorHandleOptions", "optional": true }, { "kind": "member", "docs": [ "Mini Chart options." ], "name": "miniChart", "type": "AgNavigatorMiniChartOptions", "optional": true } ] }, "AgNightingaleSeriesOptions": { "kind": "interface", "name": "AgNightingaleSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Nightingale Series." ], "name": "type", "type": "'nightingale'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadialSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the radial columns." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRadialSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The number to normalise the bar stacks to. Has no effect unless series are stacked." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Whether to group together (adjacently) separate sectors." ], "name": "grouped", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the sectors should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgNightingaleSeriesThemeOverrides": { "kind": "interface", "name": "AgNightingaleSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgNightingaleSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgPolarAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgNightingaleSeriesThemeableOptions": { "kind": "interface", "name": "AgNightingaleSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadialSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the radial columns." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRadialSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgNodeClickEvent": { "kind": "interface", "name": "AgNodeClickEvent", "members": [ { "kind": "member", "docs": [ "Event type." ], "name": "type", "type": "TEvent", "optional": false }, { "kind": "member", "docs": [ "Series ID, as specified in `series.id` (or generated if not specified)" ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Datum from the chart or series data array." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "name": "event", "type": "Event", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options" ], "name": "xKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yKey as specified on series options" ], "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "sizeKey as specified on series options" ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "labelKey as specified on series options" ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "colorKey as specified on series options" ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "angleKey as specified on series options" ], "name": "angleKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "calloutLabelKey as specified on series options" ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "sectorLabelKey as specified on series options" ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "radiusKey as specified on series options" ], "name": "radiusKey", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TEvent", "constraint": "string", "default": null }, { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "any", "TEvent": "'nodeContextMenuAction'", "T": "TEvent" } }, "AgNodeContextMenuActionEvent": { "name": "AgNodeContextMenuActionEvent", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "Event type." ], "name": "type", "type": "TEvent", "optional": false }, { "kind": "member", "docs": [ "Series ID, as specified in `series.id` (or generated if not specified)" ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Datum from the chart or series data array." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "name": "event", "type": "Event", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options" ], "name": "xKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yKey as specified on series options" ], "name": "yKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "sizeKey as specified on series options" ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "labelKey as specified on series options" ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "colorKey as specified on series options" ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "angleKey as specified on series options" ], "name": "angleKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "calloutLabelKey as specified on series options" ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "sectorLabelKey as specified on series options" ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "radiusKey as specified on series options" ], "name": "radiusKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any", "TEvent": "'nodeContextMenuAction'", "T": "TEvent" } }, "AgNoteAnnotation": { "kind": "interface", "name": "AgNoteAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the note annotation." ], "name": "type", "type": "'note'", "optional": false }, { "kind": "member", "docs": [ "The text content." ], "name": "text", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The x-value of the point." ], "name": "x", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "The y-value of the point." ], "name": "y", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The fill and stroke for note icon." ], "name": "background", "type": "AgNoteAnnotationBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgNoteAnnotationBackground": { "kind": "interface", "name": "AgNoteAnnotationBackground", "members": [ { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgNoteAnnotationStyles": { "kind": "interface", "name": "AgNoteAnnotationStyles", "members": [ { "kind": "member", "name": "background", "type": "AgNoteAnnotationBackground", "optional": true }, { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgNumberAxisOptions": { "kind": "interface", "name": "AgNumberAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'number'", "optional": false }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgCartesianCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": "number", "TInterval": "number" } }, "AgNumberAxisThemeOptions": { "kind": "interface", "name": "AgNumberAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `top` positioned axes. Same configs apply here as one level above. For example, to rotate labels by 45 degrees in 'top' positioned axes one can use `top: { label: { rotation: 45 } } }`." ], "name": "top", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `right` positioned axes. Same configs apply here as one level above." ], "name": "right", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `bottom` positioned axes. Same configs apply here as one level above." ], "name": "bottom", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `left` positioned axes. Same configs apply here as one level above." ], "name": "left", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "name": "crossLines", "type": "AgCrossLineThemeOptions", "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": "number", "TInterval": "number", "T": "AgNumberAxisOptions" } }, "AgOhlcMiniChartSeriesOptions": { "kind": "interface", "name": "AgOhlcMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the OHLC Series." ], "name": "type", "type": "'ohlc'", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Function used to return formatting for individual items, based on the given parameters. If the current datum is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgOhlcSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgOhlcSeriesItemOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the series items." ], "name": "item", "type": "AgOhlcSeriesItem", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgOhlcSeriesBaseItemStylerParams": { "name": "AgOhlcSeriesBaseItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The unique identifier of the item." ], "name": "itemId", "type": "ItemType", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "ItemType": "AgOhlcSeriesItemType" } }, "AgOhlcSeriesBaseOptions": { "name": "AgOhlcSeriesBaseOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true } ] }, "AgOhlcSeriesBaseTooltipRendererParams": { "kind": "interface", "name": "AgOhlcSeriesBaseTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "Direction of the datum" ], "name": "itemId", "type": { "kind": "union", "type": [ "'up'", "'down'" ] }, "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgOhlcSeriesItem": { "kind": "interface", "name": "AgOhlcSeriesItem", "members": [ { "kind": "member", "docs": [ "Configuration for the rising series items." ], "name": "up", "type": "AgOhlcSeriesItemOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the falling series items." ], "name": "down", "type": "AgOhlcSeriesItemOptions", "optional": true } ] }, "AgOhlcSeriesItemOptions": { "name": "AgOhlcSeriesItemOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgOhlcSeriesItemStylerParams": { "name": "AgOhlcSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The unique identifier of the item." ], "name": "itemId", "type": "ItemType", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "ItemType": "AgOhlcSeriesItemType" } }, "AgOhlcSeriesItemType": { "kind": "typeAlias", "name": "AgOhlcSeriesItemType", "type": { "kind": "union", "type": [ "'up'", "'down'" ] } }, "AgOhlcSeriesOptions": { "kind": "interface", "name": "AgOhlcSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the OHLC Series." ], "name": "type", "type": "'ohlc'", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgOhlcSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual items, based on the given parameters. If the current datum is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgOhlcSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgOhlcSeriesItemOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the series items." ], "name": "item", "type": "AgOhlcSeriesItem", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgOhlcSeriesOptionsKeys": { "kind": "interface", "name": "AgOhlcSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "TDatum" } }, "AgOhlcSeriesOptionsNames": { "kind": "interface", "name": "AgOhlcSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgOhlcSeriesStyles": { "kind": "interface", "name": "AgOhlcSeriesStyles", "members": [ { "kind": "member", "docs": [ "Configuration used for the series items." ], "name": "item", "type": "AgOhlcSeriesItem", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgOhlcSeriesThemeOverrides": { "kind": "interface", "name": "AgOhlcSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgOhlcSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgOhlcSeriesThemeableOptions": { "kind": "interface", "name": "AgOhlcSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgOhlcSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual items, based on the given parameters. If the current datum is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgOhlcSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgOhlcSeriesItemOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the series items." ], "name": "item", "type": "AgOhlcSeriesItem", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgOhlcSeriesTooltipRendererParams": { "kind": "interface", "name": "AgOhlcSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "Direction of the datum" ], "name": "itemId", "type": { "kind": "union", "type": [ "'up'", "'down'" ] }, "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve open values from the data." ], "name": "openKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve close values from the data." ], "name": "closeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve high values from the data." ], "name": "highKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve low values from the data." ], "name": "lowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "openName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "closeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "highName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "lowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgOrdinalTimeAxisOptions": { "kind": "interface", "name": "AgOrdinalTimeAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'ordinal-time'", "optional": false }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ { "kind": "union", "type": [ "TimeInterval", "number" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The padding on the outside i.e. left and right of the first and last category. In association with `paddingInner`, this value can be between 0 and 1." ], "name": "paddingOuter", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped column/bar series plotted on a category axis. It is a proportion between 0 and 1 which determines the size of the gap between the bars or columns within a single group along the axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgCartesianCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel" } }, "AgOrdinalTimeAxisThemeOptions": { "kind": "interface", "name": "AgOrdinalTimeAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ { "kind": "union", "type": [ "TimeInterval", "number" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The padding on the outside i.e. left and right of the first and last category. In association with `paddingInner`, this value can be between 0 and 1." ], "name": "paddingOuter", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped column/bar series plotted on a category axis. It is a proportion between 0 and 1 which determines the size of the gap between the bars or columns within a single group along the axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `top` positioned axes. Same configs apply here as one level above. For example, to rotate labels by 45 degrees in 'top' positioned axes one can use `top: { label: { rotation: 45 } } }`." ], "name": "top", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `right` positioned axes. Same configs apply here as one level above." ], "name": "right", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `bottom` positioned axes. Same configs apply here as one level above." ], "name": "bottom", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `left` positioned axes. Same configs apply here as one level above." ], "name": "left", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "name": "crossLines", "type": "AgCrossLineThemeOptions", "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "T": "AgOrdinalTimeAxisOptions" } }, "AgPaginationLabelOptions": { "kind": "interface", "name": "AgPaginationLabelOptions", "members": [ { "kind": "member", "docs": [ "The colour of the text." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the pagination label." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the pagination label." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the pagination label." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the pagination label." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgPaginationMarkerOptions": { "kind": "interface", "name": "AgPaginationMarkerOptions", "members": [ { "kind": "member", "docs": [ "The size in pixels of the pagination buttons." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "If set, overrides the marker shape for the pagination buttons. If not set, the pagination buttons will default to the `'triangle'` marker shape." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The inner padding in pixels between a pagination button and the pagination label." ], "name": "padding", "type": "PixelSize", "optional": true } ] }, "AgPaginationMarkerStyle": { "kind": "interface", "name": "AgPaginationMarkerStyle", "members": [ { "kind": "member", "docs": [ "The fill colour to use for the pagination button markers." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "Opacity of the pagination buttons." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the button strokes." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the button strokes." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Opacity of the button strokes." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgPaletteColors": { "kind": "interface", "name": "AgPaletteColors", "members": [ { "kind": "member", "name": "fill", "type": "AgColorTypeStrict", "optional": true }, { "kind": "member", "name": "stroke", "type": "CssColor", "optional": true } ] }, "AgParallelChannelAnnotation": { "kind": "interface", "name": "AgParallelChannelAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the parallel-channel annotation." ], "name": "type", "type": "'parallel-channel'", "optional": false }, { "kind": "member", "docs": [ "The height of the annotation along the y-axis." ], "name": "height", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the line in the middle of the channel." ], "name": "middle", "type": "AgChannelAnnotationMiddle", "optional": true }, { "kind": "member", "docs": [ "The fill colour for the middle of the channel." ], "name": "background", "type": "AgChannelAnnotationBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the channel text." ], "name": "text", "type": "AgChannelAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgPath": { "kind": "interface", "name": "AgPath", "members": [ { "kind": "member", "name": "moveTo", "type": { "kind": "function", "params": [ { "kind": "param", "name": "x", "type": "number" }, { "kind": "param", "name": "y", "type": "number" } ], "returnType": "void" }, "optional": false }, { "kind": "member", "name": "lineTo", "type": { "kind": "function", "params": [ { "kind": "param", "name": "x", "type": "number" }, { "kind": "param", "name": "y", "type": "number" } ], "returnType": "void" }, "optional": false }, { "kind": "member", "name": "rect", "type": { "kind": "function", "params": [ { "kind": "param", "name": "x", "type": "number" }, { "kind": "param", "name": "y", "type": "number" }, { "kind": "param", "name": "width", "type": "number" }, { "kind": "param", "name": "height", "type": "number" } ], "returnType": "void" }, "optional": false }, { "kind": "member", "name": "roundRect", "type": { "kind": "function", "params": [ { "kind": "param", "name": "x", "type": "number" }, { "kind": "param", "name": "y", "type": "number" }, { "kind": "param", "name": "width", "type": "number" }, { "kind": "param", "name": "height", "type": "number" }, { "kind": "param", "name": "radii", "type": "number" } ], "returnType": "void" }, "optional": false }, { "kind": "member", "name": "arc", "type": { "kind": "function", "params": [ { "kind": "param", "name": "x", "type": "number" }, { "kind": "param", "name": "y", "type": "number" }, { "kind": "param", "name": "r", "type": "number" }, { "kind": "param", "name": "sAngle", "type": "number" }, { "kind": "param", "name": "eAngle", "type": "number" }, { "kind": "param", "name": "counterClockwise", "type": "boolean" } ], "returnType": "void" }, "optional": false }, { "kind": "member", "name": "cubicCurveTo", "type": { "kind": "function", "params": [ { "kind": "param", "name": "cx1", "type": "number" }, { "kind": "param", "name": "cy1", "type": "number" }, { "kind": "param", "name": "cx2", "type": "number" }, { "kind": "param", "name": "cy2", "type": "number" }, { "kind": "param", "name": "x", "type": "number" }, { "kind": "param", "name": "y", "type": "number" } ], "returnType": "void" }, "optional": false }, { "kind": "member", "name": "closePath", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false }, { "kind": "member", "name": "clear", "type": { "kind": "function", "params": [ { "kind": "param", "name": "trackChanges", "type": "boolean" } ], "returnType": "void" }, "optional": false } ] }, "AgPatternColor": { "kind": "interface", "name": "AgPatternColor", "members": [ { "kind": "member", "name": "type", "type": "'pattern'", "optional": false }, { "kind": "member", "docs": [ "The stock pattern to apply." ], "name": "pattern", "type": "AgPatternName", "optional": true }, { "kind": "member", "docs": [ "Width of the pattern unit." ], "name": "width", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Height of the pattern unit." ], "name": "height", "type": "number", "optional": true }, { "kind": "member", "docs": [ "The colour for filling closed shapes in the pattern." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the shapes fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling the background in the pattern." ], "name": "backgroundFill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the background fill colour." ], "name": "backgroundFillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the strokes of shapes in the pattern." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the shapes stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke of shapes in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true } ] }, "AgPatternName": { "kind": "typeAlias", "name": "AgPatternName", "type": { "kind": "union", "type": [ "'vertical-lines'", "'horizontal-lines'", "'forward-slanted-lines'", "'backward-slanted-lines'", "'squares'", "'circles'", "'triangles'", "'diamonds'", "'stars'", "'hearts'", "'crosses'" ] } }, "AgPieSeriesCalloutOptions": { "kind": "interface", "name": "AgPieSeriesCalloutOptions", "members": [ { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the callouts." ], "name": "colors", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The length in pixels of the callout lines." ], "name": "length", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for callout lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true } ] }, "AgPieSeriesItemStylerParams": { "name": "AgPieSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple pie series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true } ] }, "AgPieSeriesLabelFormatterParams": { "name": "AgPieSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple pie series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "calloutLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the sector label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "sectorLabelName", "type": "string", "optional": true } ] }, "AgPieSeriesLabelOptions": { "kind": "interface", "name": "AgPieSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Distance in pixels between the callout line and the label text." ], "name": "offset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Minimum angle in degrees required for a sector to show a label." ], "name": "minAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid callout label collision and overflow by automatically moving colliding labels or reducing the pie radius. If set to `false`, callout labels may collide with each other and the pie radius will not change to prevent clipping of callout labels." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgPieSeriesOptions": { "kind": "interface", "name": "AgPieSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Pie Series." ], "name": "type", "type": "'pie'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration for the series title." ], "name": "title", "type": "AgPieTitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels used outside the sectors." ], "name": "calloutLabel", "type": { "kind": "typeRef", "type": "AgPieSeriesLabelOptions", "typeArguments": [ "TDatum", "AgPieSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels used inside the sectors." ], "name": "sectorLabel", "type": { "kind": "typeRef", "type": "AgPieSeriesSectorLabelOptions", "typeArguments": [ "TDatum", "AgPieSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the callout lines used with the labels for the sectors." ], "name": "calloutLine", "type": "AgPieSeriesCalloutOptions", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the sectors." ], "name": "fills", "type": { "kind": "array", "type": "AgColorType" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the sectors." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the sectors." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the sectors." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the sectors." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The rotation of the pie series in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "The offset in pixels of the outer radius of the series." ], "name": "outerRadiusOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The ratio of the outer radius of the series. Used to adjust the outer radius proportionally to the automatically calculated value." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Override of the automatically determined minimum radiusKey value from the data." ], "name": "radiusMin", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Override of the automatically determined maximum radiusKey value from the data." ], "name": "radiusMax", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgPieSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The spacing between Pie sectors." ], "name": "sectorSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether items with a value of 0 should be hidden in the legend." ], "name": "hideZeroValueSectorsInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the pie sectors." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgPieSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgPieSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple pie series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "calloutLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the sector label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "sectorLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgPieSeriesOptionsKeys": { "kind": "interface", "name": "AgPieSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple pie series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgPieSeriesOptionsNames": { "kind": "interface", "name": "AgPieSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "calloutLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the sector label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "sectorLabelName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgPieSeriesSectorLabelOptions": { "kind": "interface", "name": "AgPieSeriesSectorLabelOptions", "members": [ { "kind": "member", "docs": [ "Distance in pixels, used to make the label text closer to or further from the center. This offset is applied after positionRatio." ], "name": "positionOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Position of labels as a ratio proportional to pie radius. Additional offset in pixels can be applied by using positionOffset." ], "name": "positionRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgPieSeriesStyle": { "kind": "interface", "name": "AgPieSeriesStyle", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgPieSeriesThemeOverrides": { "kind": "interface", "name": "AgPieSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgPieSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgPieSeriesThemeableOptions": { "kind": "interface", "name": "AgPieSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the series title." ], "name": "title", "type": "AgPieTitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels used outside the sectors." ], "name": "calloutLabel", "type": { "kind": "typeRef", "type": "AgPieSeriesLabelOptions", "typeArguments": [ "TDatum", "AgPieSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels used inside the sectors." ], "name": "sectorLabel", "type": { "kind": "typeRef", "type": "AgPieSeriesSectorLabelOptions", "typeArguments": [ "TDatum", "AgPieSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the callout lines used with the labels for the sectors." ], "name": "calloutLine", "type": "AgPieSeriesCalloutOptions", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the sectors." ], "name": "fills", "type": { "kind": "array", "type": "AgColorType" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the sectors." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the sectors." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the sectors." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the sectors." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The rotation of the pie series in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "The offset in pixels of the outer radius of the series." ], "name": "outerRadiusOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The ratio of the outer radius of the series. Used to adjust the outer radius proportionally to the automatically calculated value." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Override of the automatically determined minimum radiusKey value from the data." ], "name": "radiusMin", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Override of the automatically determined maximum radiusKey value from the data." ], "name": "radiusMax", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the chart series." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgPieSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The spacing between Pie sectors." ], "name": "sectorSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether items with a value of 0 should be hidden in the legend." ], "name": "hideZeroValueSectorsInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the pie sectors." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgPieSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgPieSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgPieSeriesTooltipRendererParams": { "kind": "interface", "name": "AgPieSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve label values from the data." ], "name": "calloutLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve sector label values from the data." ], "name": "sectorLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve legend item labels from the data. If multiple pie series share this key they will be merged in the legend." ], "name": "legendItemKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "calloutLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the sector label values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "sectorLabelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgPieTitleOptions": { "kind": "interface", "name": "AgPieTitleOptions", "members": [ { "kind": "member", "docs": [ "The text to display." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Spacing added to help position the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether the title text should be shown in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgPolarAxesTheme": { "kind": "interface", "name": "AgPolarAxesTheme", "members": [ { "kind": "member", "name": "'angle-category'", "type": "AgAngleCategoryAxisThemeOptions", "optional": true }, { "kind": "member", "name": "'angle-number'", "type": "AgAngleNumberAxisThemeOptions", "optional": true }, { "kind": "member", "name": "'radius-category'", "type": "AgRadiusCategoryAxisThemeOptions", "optional": true }, { "kind": "member", "name": "'radius-number'", "type": "AgRadiusNumberAxisThemeOptions", "optional": true } ] }, "AgPolarAxisOptions": { "kind": "typeAlias", "name": "AgPolarAxisOptions", "type": { "kind": "union", "type": [ "AgAngleCategoryAxisOptions", "AgAngleNumberAxisOptions", "AgRadiusCategoryAxisOptions", "AgRadiusNumberAxisOptions" ] } }, "AgPolarAxisShape": { "kind": "typeAlias", "name": "AgPolarAxisShape", "type": { "kind": "union", "type": [ "'polygon'", "'circle'" ] } }, "AgPolarAxisType": { "kind": "typeAlias", "name": "AgPolarAxisType", "type": { "kind": "indexAccess", "type": "AgPolarAxisOptions", "index": "'type'" } }, "AgPolarChartOptions": { "kind": "interface", "name": "AgPolarChartOptions", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgPolarSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": { "kind": "array", "type": "AgPolarAxisOptions" }, "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgPolarSeriesOptions": { "kind": "typeAlias", "name": "AgPolarSeriesOptions", "type": { "kind": "union", "type": [ "AgDonutSeriesOptions", "AgPieSeriesOptions", "AgRadarLineSeriesOptions", "AgRadarAreaSeriesOptions", "AgRadialBarSeriesOptions", "AgRadialColumnSeriesOptions", "AgNightingaleSeriesOptions" ] } }, "AgPreset": { "kind": "typeAlias", "name": "AgPreset", "type": { "kind": "union", "type": [ "AgFinancialChartPresets", "AgGaugePresets", "AgSparklinePresets" ] } }, "AgPresetOptions": { "kind": "typeAlias", "name": "AgPresetOptions", "type": { "kind": "union", "type": [ "AgFinancialChartOptions", "AgGaugeOptions", "AgSparklineOptions" ] } }, "AgPresetOverrides": { "kind": "interface", "name": "AgPresetOverrides", "members": [ { "kind": "member", "docs": [ "Radial gauge theme overrides." ], "name": "'radial-gauge'", "type": "AgRadialGaugeThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Linear Gauge theme overrides." ], "name": "'linear-gauge'", "type": "AgLinearGaugeThemeOverrides", "optional": true } ] }, "AgPreventableEvent": { "kind": "interface", "name": "AgPreventableEvent", "members": [ { "kind": "member", "docs": [ "Prevent the AG Charts built-in default event handlers from running." ], "name": "preventDefault", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false } ], "genericsMap": { "T": "'dblclick'" } }, "AgPriceRangeAnnotation": { "kind": "interface", "name": "AgPriceRangeAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the price range annotation." ], "name": "type", "type": "'price-range'", "optional": false }, { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "Whether the annotation should be extended to the left." ], "name": "extendLeft", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended to the right." ], "name": "extendRight", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Configuration for the drag handles." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Configuration for the statistics." ], "name": "statistics", "type": "AgMeasurerAnnotationStatistics", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgPriceVolumeChartType": { "kind": "typeAlias", "name": "AgPriceVolumeChartType", "type": { "kind": "union", "type": [ "'candlestick'", "'hollow-candlestick'", "'ohlc'", "'line'", "'step-line'", "'hlc'", "'high-low'" ] } }, "AgPriceVolumePreset": { "kind": "interface", "name": "AgPriceVolumePreset", "members": [ { "kind": "member", "docs": [ "Series type used for the OHLC data." ], "name": "chartType", "type": "AgPriceVolumeChartType", "optional": true, "defaultValue": "'candlestick'" }, { "kind": "member", "docs": [ "The key used to retrieve x-values from the data." ], "name": "dateKey", "type": "string", "optional": true, "defaultValue": "'date'" }, { "kind": "member", "docs": [ "The key used to retrieve 'open' values from the data." ], "name": "openKey", "type": "string", "optional": true, "defaultValue": "'open'" }, { "kind": "member", "docs": [ "The key used to retrieve 'high' values from the data." ], "name": "highKey", "type": "string", "optional": true, "defaultValue": "'high'" }, { "kind": "member", "docs": [ "The key used to retrieve 'low' values from the data." ], "name": "lowKey", "type": "string", "optional": true, "defaultValue": "'low'" }, { "kind": "member", "docs": [ "The key used to retrieve 'close' values from the data." ], "name": "closeKey", "type": "string", "optional": true, "defaultValue": "'close'" }, { "kind": "member", "docs": [ "The key used to retrieve 'volume' values from the data." ], "name": "volumeKey", "type": "string", "optional": true, "defaultValue": "'volume'" }, { "kind": "member", "docs": [ "Whether to show the Navigator and mini-chart beneath the main chart." ], "name": "navigator", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether to show the volume series at the bottom of the chart.", " If set to `false`, no volume data is required." ], "name": "volume", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether to show the range buttons." ], "name": "rangeButtons", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether to show the status bar." ], "name": "statusBar", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether the toolbar is enabled." ], "name": "toolbar", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Whether Zoom is enabled." ], "name": "zoom", "type": "boolean", "optional": true, "defaultValue": "true" } ], "genericsMap": { "TDatum": "any" } }, "AgPyramidSeriesItemStylerParams": { "kind": "interface", "name": "AgPyramidSeriesItemStylerParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgPyramidSeriesLabelFormatterParams": { "kind": "interface", "name": "AgPyramidSeriesLabelFormatterParams", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false } ] }, "AgPyramidSeriesLabelOptions": { "name": "AgPyramidSeriesLabelOptions", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgPyramidSeriesOptions": { "kind": "interface", "name": "AgPyramidSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Funnel Series." ], "name": "type", "type": "'pyramid'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the stages." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the stages." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the stages." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the stages." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the stages." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Stage rendering direction." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the order of the stages." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Spacing between the stages." ], "name": "spacing", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Ratio of the triangle width to its height. When unset, the triangle will fill the available space." ], "name": "aspectRatio", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on stages." ], "name": "label", "type": { "kind": "typeRef", "type": "AgPyramidSeriesLabelOptions", "typeArguments": [ "TDatum", "AgPyramidSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the stage labels." ], "name": "stageLabel", "type": { "kind": "typeRef", "type": "AgPyramidSeriesStageLabelOptions", "typeArguments": [ "TDatum", "AgPyramidSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgPyramidSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual bars, based on the given parameters. If the current bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgPyramidSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgPyramidSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgPyramidSeriesOptionsKeys": { "kind": "interface", "name": "AgPyramidSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "any" } }, "AgPyramidSeriesOptionsNames": { "kind": "interface", "name": "AgPyramidSeriesOptionsNames", "members": [], "genericsMap": { "TDatum": "any" } }, "AgPyramidSeriesStageLabelOptions": { "kind": "interface", "name": "AgPyramidSeriesStageLabelOptions", "members": [ { "kind": "member", "docs": [ "Placement of the label in relation to the chart." ], "name": "placement", "type": { "kind": "union", "type": [ "'before'", "'after'" ] }, "optional": true }, { "kind": "member", "docs": [ "Spacing of the label in relation to the chart." ], "name": "spacing", "type": "number", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgPyramidSeriesStyle": { "kind": "interface", "name": "AgPyramidSeriesStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgPyramidSeriesThemeableOptions": { "kind": "interface", "name": "AgPyramidSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The colours to cycle through for the fills of the stages." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the stages." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the stages." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the stages." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the stages." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Stage rendering direction." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the order of the stages." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Spacing between the stages." ], "name": "spacing", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Ratio of the triangle width to its height. When unset, the triangle will fill the available space." ], "name": "aspectRatio", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on stages." ], "name": "label", "type": { "kind": "typeRef", "type": "AgPyramidSeriesLabelOptions", "typeArguments": [ "TDatum", "AgPyramidSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the stage labels." ], "name": "stageLabel", "type": { "kind": "typeRef", "type": "AgPyramidSeriesStageLabelOptions", "typeArguments": [ "TDatum", "AgPyramidSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgPyramidSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual bars, based on the given parameters. If the current bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgPyramidSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgPyramidSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgPyramidSeriesTooltipRendererParams": { "kind": "interface", "name": "AgPyramidSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve stage values from the data." ], "name": "stageKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data." ], "name": "valueKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgPyramidThemeOverrides": { "kind": "interface", "name": "AgPyramidThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgPyramidSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgQuickMeasurerAnnotationDirectionStyles": { "kind": "interface", "name": "AgQuickMeasurerAnnotationDirectionStyles", "members": [ { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "name": "statistics", "type": "AgMeasurerAnnotationStatistics", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgQuickMeasurerAnnotationStyles": { "kind": "interface", "name": "AgQuickMeasurerAnnotationStyles", "members": [ { "kind": "member", "name": "up", "type": "AgQuickMeasurerAnnotationDirectionStyles", "optional": true }, { "kind": "member", "name": "down", "type": "AgQuickMeasurerAnnotationDirectionStyles", "optional": true }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true } ] }, "AgRadarAreaSeriesOptions": { "kind": "interface", "name": "AgRadarAreaSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Radar Area Series." ], "name": "type", "type": "'radar-area'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgRadialSeriesOptionsKeys" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadarSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadarSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRadarAreaSeriesThemeOverrides": { "kind": "interface", "name": "AgRadarAreaSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgRadarAreaSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgPolarAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadarAreaSeriesThemeableOptions": { "kind": "interface", "name": "AgRadarAreaSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgRadialSeriesOptionsKeys" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadarSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadarSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRadarLineSeriesOptions": { "kind": "interface", "name": "AgRadarLineSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Radar Line Series." ], "name": "type", "type": "'radar-line'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgRadialSeriesOptionsKeys" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadarSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadarSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRadarLineSeriesThemeOverrides": { "kind": "interface", "name": "AgRadarLineSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgRadarSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgPolarAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadarSeriesItemStylerParams": { "name": "AgRadarSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgRadarSeriesLabelFormatterParams": { "name": "AgRadarSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true } ] }, "AgRadarSeriesThemeableOptions": { "kind": "interface", "name": "AgRadarSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgRadialSeriesOptionsKeys" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadarSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadarSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRadarSeriesTooltipRendererParams": { "name": "AgRadarSeriesTooltipRendererParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRadialBarSeriesOptions": { "kind": "interface", "name": "AgRadialBarSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Radial Bar Series." ], "name": "type", "type": "'radial-bar'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The number to normalise the bar stacks to. Has no effect unless series are stacked." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Whether to group together (adjacently) separate sectors." ], "name": "grouped", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the sectors should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadialSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the radial columns." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRadialSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRadialBarSeriesThemeOverrides": { "kind": "interface", "name": "AgRadialBarSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgRadialBarSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgPolarAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadialBarSeriesThemeableOptions": { "name": "AgRadialBarSeriesThemeableOptions", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadialSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the radial columns." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRadialSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadialColumnSeriesOptions": { "kind": "interface", "name": "AgRadialColumnSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for Radial Column Series." ], "name": "type", "type": "'radial-column'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The ratio used to calculate the column width based on the circumference and padding between items." ], "name": "columnWidthRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Prevents columns from becoming too wide. This value is relative to the diameter of the polar chart." ], "name": "maxColumnWidthRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadialSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the radial columns." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRadialSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The number to normalise the bar stacks to. Has no effect unless series are stacked." ], "name": "normalizedTo", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Whether to group together (adjacently) separate sectors." ], "name": "grouped", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An option indicating if the sectors should be stacked." ], "name": "stacked", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "An ID to be used to group stacked items." ], "name": "stackGroup", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRadialColumnSeriesThemeOverrides": { "kind": "interface", "name": "AgRadialColumnSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgRadialColumnSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgPolarAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadialColumnSeriesThemeableOptions": { "kind": "interface", "name": "AgRadialColumnSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The ratio used to calculate the column width based on the circumference and padding between items." ], "name": "columnWidthRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Prevents columns from becoming too wide. This value is relative to the diameter of the polar chart." ], "name": "maxColumnWidthRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartLabelOptions", "typeArguments": [ "TDatum", "AgRadialSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A styler function for adjusting the styling of the radial columns." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRadialSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRadialSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRadialGaugeBarStyle": { "kind": "interface", "name": "AgRadialGaugeBarStyle", "members": [ { "kind": "member", "docs": [ "Whether the bar should be shown." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for two or more colours, and the values they are rendered at." ], "name": "fills", "type": { "kind": "array", "type": "AgGaugeColorStop" }, "optional": true }, { "kind": "member", "docs": [ "Configuration the fills should be rendered." ], "name": "fillMode", "type": "AgGaugeFillMode", "optional": true, "defaultValue": "continuous" }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgRadialGaugeItemStylerParams": { "kind": "interface", "name": "AgRadialGaugeItemStylerParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false } ], "genericsMap": { "TDatum": "GaugeDatum" } }, "AgRadialGaugeLabelFormatterParams": { "kind": "interface", "name": "AgRadialGaugeLabelFormatterParams", "members": [ { "kind": "member", "name": "value", "type": "number", "optional": false } ] }, "AgRadialGaugeLabelOptions": { "kind": "interface", "name": "AgRadialGaugeLabelOptions", "members": [ { "kind": "member", "docs": [ "Text to always display." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The distance between the label and secondary label, if both are present" ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Line height to use for the label." ], "name": "lineHeight", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "If the label does not fit in the container, setting this will allow the label to pick a font size between its normal `fontSize` and `minimumFontSize` to fit within the container." ], "name": "minimumFontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for labels.", "- `'always'` will always wrap text to fit within the tile.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tile dimensions, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" }, { "kind": "member", "docs": [ "Adjusts the behaviour of labels when they overflow", "- `'ellipsis'` will truncate the text to fit, appending an ellipsis (...)", "- `'hide'` only displays the label if it completely fits within its bounds, and removes it if it would overflow" ], "name": "overflowStrategy", "type": "OverflowStrategy", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "genericsMap": { "TDatum": "undefined", "TParams": "AgRadialGaugeLabelFormatterParams" } }, "AgRadialGaugeMarkerShape": { "kind": "typeAlias", "name": "AgRadialGaugeMarkerShape", "type": { "kind": "union", "type": [ "AgMarkerShape", "'line'" ] } }, "AgRadialGaugeNeedleStyle": { "kind": "interface", "name": "AgRadialGaugeNeedleStyle", "members": [ { "kind": "member", "docs": [ "Whether the needle should be shown." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Ratio of the size of the needle." ], "name": "radiusRatio", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Spacing between radiusRatio, in pixels." ], "name": "spacing", "type": "number", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgRadialGaugeOptions": { "name": "AgRadialGaugeOptions", "kind": "interface", "members": [ { "kind": "member", "docs": [ "Configuration for the Radial Gauge." ], "name": "type", "type": "'radial-gauge'", "optional": false }, { "kind": "member", "docs": [ "Value of the Radial Gauge." ], "name": "value", "type": "number", "optional": false }, { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the targets." ], "name": "targets", "type": { "kind": "array", "type": "AgRadialGaugeTarget" }, "optional": true }, { "kind": "member", "docs": [ "Outer radius of the gauge." ], "name": "outerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Inner radius of the gauge." ], "name": "innerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Ratio of the outer radius of the gauge." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Ratio of the inner radius of the gauge." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the start of the gauge." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the end of the gauge." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the needle." ], "name": "needle", "type": "AgRadialGaugeNeedleStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the scale." ], "name": "scale", "type": "AgRadialGaugeScale", "optional": true }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgRadialGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgRadialGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "secondaryLabel", "type": "AgRadialGaugeSecondaryLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadialGaugePreset": { "kind": "interface", "name": "AgRadialGaugePreset", "members": [ { "kind": "member", "docs": [ "Configuration for the Radial Gauge." ], "name": "type", "type": "'radial-gauge'", "optional": false }, { "kind": "member", "docs": [ "Value of the Radial Gauge." ], "name": "value", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Configuration for the targets." ], "name": "targets", "type": { "kind": "array", "type": "AgRadialGaugeTarget" }, "optional": true }, { "kind": "member", "docs": [ "Outer radius of the gauge." ], "name": "outerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Inner radius of the gauge." ], "name": "innerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Ratio of the outer radius of the gauge." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Ratio of the inner radius of the gauge." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the start of the gauge." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the end of the gauge." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the needle." ], "name": "needle", "type": "AgRadialGaugeNeedleStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the scale." ], "name": "scale", "type": "AgRadialGaugeScale", "optional": true }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgRadialGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgRadialGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "secondaryLabel", "type": "AgRadialGaugeSecondaryLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgRadialGaugeTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "GaugeDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadialGaugeScale": { "kind": "interface", "name": "AgRadialGaugeScale", "members": [ { "kind": "member", "docs": [ "Maximum value of the scale. Any values exceeding this number will be clipped to this maximum." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Minimum value of the scale. Any values exceeding this number will be clipped to this minimum." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration for the scale labels." ], "name": "label", "type": "AgRadialGaugeScaleLabel", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ticks interval." ], "name": "interval", "type": "AgRadialGaugeScaleInterval", "optional": true }, { "kind": "member", "docs": [ "Configuration for two or more colours, and the values they are rendered at." ], "name": "fills", "type": { "kind": "array", "type": "AgGaugeColorStop" }, "optional": true }, { "kind": "member", "docs": [ "Configuration the fills should be rendered." ], "name": "fillMode", "type": "AgGaugeFillMode", "optional": true, "defaultValue": "continuous" }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgRadialGaugeScaleInterval": { "kind": "interface", "name": "AgRadialGaugeScaleInterval", "members": [ { "kind": "member", "docs": [ "Array of values in scale units for specified intervals along the scale. The values in this array must be compatible with the scale type." ], "name": "values", "type": { "kind": "array", "type": "number" }, "optional": true }, { "kind": "member", "docs": [ "The scale interval. Expressed in the units of the scale. If the configured interval results in too many items given the chart size, it will be ignored." ], "name": "step", "type": "number", "optional": true } ] }, "AgRadialGaugeScaleLabel": { "kind": "interface", "name": "AgRadialGaugeScaleLabel", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the scale labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the scale label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The rotation of the scale labels in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid scale label collision by automatically reducing the number of ticks displayed. If set to `false`, scale labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the scale labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Function used to render scale labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true } ] }, "AgRadialGaugeSecondaryLabelOptions": { "kind": "interface", "name": "AgRadialGaugeSecondaryLabelOptions", "members": [ { "kind": "member", "docs": [ "Text to always display." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Line height to use for the label." ], "name": "lineHeight", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "If the label does not fit in the container, setting this will allow the label to pick a font size between its normal `fontSize` and `minimumFontSize` to fit within the container." ], "name": "minimumFontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "Text wrapping strategy for labels.", "- `'always'` will always wrap text to fit within the tile.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tile dimensions, the text will be truncated.", "- `'never'` disables text wrapping." ], "name": "wrapping", "type": "TextWrap", "optional": true, "defaultValue": "'on-space'" }, { "kind": "member", "docs": [ "Adjusts the behaviour of labels when they overflow", "- `'ellipsis'` will truncate the text to fit, appending an ellipsis (...)", "- `'hide'` only displays the label if it completely fits within its bounds, and removes it if it would overflow" ], "name": "overflowStrategy", "type": "OverflowStrategy", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "genericsMap": { "TDatum": "undefined", "TParams": "AgRadialGaugeLabelFormatterParams" } }, "AgRadialGaugeStyle": { "kind": "interface", "name": "AgRadialGaugeStyle", "members": [], "genericsMap": { "TDatum": "any" } }, "AgRadialGaugeTarget": { "kind": "interface", "name": "AgRadialGaugeTarget", "members": [ { "kind": "member", "docs": [ "Value to use to position the target" ], "name": "value", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Text to use for the target label." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgRadialGaugeMarkerShape", "optional": true }, { "kind": "member", "docs": [ "Placement of target." ], "name": "placement", "type": "AgRadialGaugeTargetPlacement", "optional": true }, { "kind": "member", "docs": [ "Spacing of the target. Ignored when placement is 'middle'." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Size of the target." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Rotation of the target, in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Label options for all targets." ], "name": "label", "type": "AgRadialGaugeTargetLabelOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgRadialGaugeTargetLabelOptions": { "kind": "interface", "name": "AgRadialGaugeTargetLabelOptions", "members": [ { "kind": "member", "docs": [ "Spacing of the label." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "genericsMap": { "TDatum": "undefined", "TParams": "never" } }, "AgRadialGaugeTargetPlacement": { "kind": "typeAlias", "name": "AgRadialGaugeTargetPlacement", "type": { "kind": "union", "type": [ "'inside'", "'outside'", "'middle'" ] } }, "AgRadialGaugeTargetTheme": { "kind": "interface", "name": "AgRadialGaugeTargetTheme", "members": [ { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgRadialGaugeMarkerShape", "optional": true }, { "kind": "member", "docs": [ "Placement of target." ], "name": "placement", "type": "AgRadialGaugeTargetPlacement", "optional": true }, { "kind": "member", "docs": [ "Spacing of the target. Ignored when placement is 'middle'." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Size of the target." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Rotation of the target, in degrees." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Label options for all targets." ], "name": "label", "type": "AgRadialGaugeTargetLabelOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgRadialGaugeTheme": { "name": "AgRadialGaugeTheme", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Outer radius of the gauge." ], "name": "outerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Inner radius of the gauge." ], "name": "innerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Ratio of the outer radius of the gauge." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Ratio of the inner radius of the gauge." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the start of the gauge." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the end of the gauge." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the needle." ], "name": "needle", "type": "AgRadialGaugeNeedleStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the scale." ], "name": "scale", "type": "AgRadialGaugeScale", "optional": true }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgRadialGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgRadialGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "secondaryLabel", "type": "AgRadialGaugeSecondaryLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadialGaugeThemeOverrides": { "kind": "interface", "name": "AgRadialGaugeThemeOverrides", "members": [ { "kind": "member", "name": "targets", "type": "AgRadialGaugeTargetTheme", "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Outer radius of the gauge." ], "name": "outerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Inner radius of the gauge." ], "name": "innerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Ratio of the outer radius of the gauge." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Ratio of the inner radius of the gauge." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the start of the gauge." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the end of the gauge." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the needle." ], "name": "needle", "type": "AgRadialGaugeNeedleStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the scale." ], "name": "scale", "type": "AgRadialGaugeScale", "optional": true }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgRadialGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgRadialGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "secondaryLabel", "type": "AgRadialGaugeSecondaryLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadialGaugeThemeableOptions": { "kind": "interface", "name": "AgRadialGaugeThemeableOptions", "members": [ { "kind": "member", "docs": [ "Outer radius of the gauge." ], "name": "outerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Inner radius of the gauge." ], "name": "innerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Ratio of the outer radius of the gauge." ], "name": "outerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Ratio of the inner radius of the gauge." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the start of the gauge." ], "name": "startAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Angle in degrees of the end of the gauge." ], "name": "endAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Configuration for a segmented appearance." ], "name": "segmentation", "type": "AgGaugeSegmentation", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to the gauge." ], "name": "cornerRadius", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Configuration on whether to apply `cornerRadius` only to the ends of the gauge, or each individual item within the gauge." ], "name": "cornerMode", "type": "AgGaugeCornerMode", "optional": true, "defaultValue": "container" }, { "kind": "member", "docs": [ "Configuration for the needle." ], "name": "needle", "type": "AgRadialGaugeNeedleStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the scale." ], "name": "scale", "type": "AgRadialGaugeScale", "optional": true }, { "kind": "member", "docs": [ "Configuration for the bar." ], "name": "bar", "type": "AgRadialGaugeBarStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "label", "type": "AgRadialGaugeLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown inside the shape." ], "name": "secondaryLabel", "type": "AgRadialGaugeSecondaryLabelOptions", "optional": true }, { "kind": "member", "docs": [ "Distance between the shape edges and the text." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgRadialGaugeTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for the gauge. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "GaugeDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRadialGaugeTooltipRendererParams": { "kind": "interface", "name": "AgRadialGaugeTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "Value of the Gauge" ], "name": "value", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRadialSeriesItemStylerParams": { "name": "AgRadialSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false } ] }, "AgRadialSeriesLabelFormatterParams": { "name": "AgRadialSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true } ] }, "AgRadialSeriesOptionsKeys": { "kind": "interface", "name": "AgRadialSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRadialSeriesOptionsNames": { "kind": "interface", "name": "AgRadialSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRadialSeriesStyle": { "kind": "interface", "name": "AgRadialSeriesStyle", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRadialSeriesTooltipRendererParams": { "kind": "interface", "name": "AgRadialSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve angle values from the data." ], "name": "angleKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve radius values from the data." ], "name": "radiusKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the angle values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "angleName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the radius values. If supplied, this will be passed to the tooltip renderer as one of the parameters." ], "name": "radiusName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRadiusAxisFormattableLabelOptions": { "kind": "interface", "name": "AgRadiusAxisFormattableLabelOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true } ] }, "AgRadiusAxisLabelOptions": { "kind": "interface", "name": "AgRadiusAxisLabelOptions", "members": [ { "kind": "member", "docs": [ "Set to `false` to hide the axis labels." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The rotation of the axis labels in degrees. Note: for integrated charts the default is 335 degrees, unless the axis shows grouped or default categories (indexes). The first row of labels in a grouped category axis is rotated perpendicular to the axis line." ], "name": "rotation", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Avoid axis label collision by automatically reducing the number of ticks displayed. If set to `false`, axis labels may collide." ], "name": "avoidCollisions", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Minimum gap in pixels between the axis labels before being removed to avoid collisions." ], "name": "minSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Function used to render axis labels. If `value` is a number, `fractionDigits` will also be provided, which indicates the number of fractional digits used in the step between ticks; for example, a tick step of `0.0005` would have `fractionDigits` set to `4`" ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "AgAxisLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to style axis labels." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ "AgAxisLabelStylerParams", "AgBaseAxisLabelStyleOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "The font style to use for the labels." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the labels." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the labels." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the labels" ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the axis label and the tick." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the labels" ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgRadiusCategoryAxisOptions": { "kind": "interface", "name": "AgRadiusCategoryAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'radius-category'", "optional": false }, { "kind": "member", "docs": [ "The rotation angle of axis line and labels in degrees." ], "name": "positionAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgRadiusCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "The ratio of the inner radius of the axis as a proportion of the overall radius. Used to create an inner circle." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a radius category axis. It is a proportion between 0 and 1 which determines the size of the gap between the items within a single group along the angle axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a radius category axis. It is a proportion between 0 and 1 which determines the size of the gap between the groups of items along the angle axis." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a radius category axis. It is a proportion between 0 and 1 which determines the size of the gap between the groups of items along the angle axis." ], "name": "paddingOuter", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true } ], "genericsMap": { "LabelType": "AgRadiusAxisLabelOptions" } }, "AgRadiusCategoryAxisThemeOptions": { "kind": "interface", "name": "AgRadiusCategoryAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "The rotation angle of axis line and labels in degrees." ], "name": "positionAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgRadiusCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "The ratio of the inner radius of the axis as a proportion of the overall radius. Used to create an inner circle." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a radius category axis. It is a proportion between 0 and 1 which determines the size of the gap between the items within a single group along the angle axis." ], "name": "groupPaddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a radius category axis. It is a proportion between 0 and 1 which determines the size of the gap between the groups of items along the angle axis." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "This property is for grouped polar series plotted on a radius category axis. It is a proportion between 0 and 1 which determines the size of the gap between the groups of items along the angle axis." ], "name": "paddingOuter", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": "AgAxisBaseIntervalOptions", "optional": true } ], "genericsMap": { "LabelType": "AgRadiusAxisLabelOptions" } }, "AgRadiusCrossLineLabelOptions": { "kind": "interface", "name": "AgRadiusCrossLineLabelOptions", "members": [ { "kind": "member", "name": "positionAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Whether to show the Cross Line label." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The text to show in the label." ], "name": "text", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The font style to use for the label." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for the label." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The font size in pixels to use for the label." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family to use for the label." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the label and the edge of the Cross Line." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the label." ], "name": "color", "type": "CssColor", "optional": true } ] }, "AgRadiusCrossLineOptions": { "kind": "interface", "name": "AgRadiusCrossLineOptions", "members": [ { "kind": "member", "docs": [ "Type of Cross Line to render, defaults to `line`." ], "name": "type", "type": { "kind": "union", "type": [ "'line'", "'range'" ] }, "optional": false }, { "kind": "member", "docs": [ "Whether to show the Cross Line." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The data value at which the line should be positioned. This property is used if the Cross Line type is `line`." ], "name": "value", "type": "AxisValue", "optional": true }, { "kind": "member", "docs": [ "The range of values from the data used to display lines at a desired chart region. This property is only used for Cross Line type `range`." ], "name": "range", "type": { "kind": "tuple", "type": [ "AxisValue", "AxisValue" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour to use for the fill of the range." ], "name": "fill", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the range." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour of the stroke for the lines." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the lines." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Cross Line label." ], "name": "label", "type": "LabelType", "optional": true } ], "genericsMap": { "LabelType": "AgRadiusCrossLineLabelOptions" } }, "AgRadiusNumberAxisOptions": { "kind": "interface", "name": "AgRadiusNumberAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'radius-number'", "optional": false }, { "kind": "member", "docs": [ "The rotation angle of axis line and labels in degrees." ], "name": "positionAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Shape of axis. Default: `polygon`" ], "name": "shape", "type": "AgPolarAxisShape", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgRadiusCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "The ratio of the inner radius of the axis as a proportion of the overall radius. Used to create an inner circle." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true } ], "genericsMap": { "LabelType": "AgRadiusAxisFormattableLabelOptions", "TDatum": "number", "TInterval": "number" } }, "AgRadiusNumberAxisThemeOptions": { "kind": "interface", "name": "AgRadiusNumberAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "The rotation angle of axis line and labels in degrees." ], "name": "positionAngle", "type": "Degree", "optional": true }, { "kind": "member", "docs": [ "Shape of axis. Default: `polygon`" ], "name": "shape", "type": "AgPolarAxisShape", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgRadiusCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "The ratio of the inner radius of the axis as a proportion of the overall radius. Used to create an inner circle." ], "name": "innerRadiusRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true } ], "genericsMap": { "LabelType": "AgRadiusAxisFormattableLabelOptions", "TDatum": "number", "TInterval": "number" } }, "AgRangeAreaMiniChartSeriesOptions": { "kind": "interface", "name": "AgRangeAreaMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Range Area Series." ], "name": "type", "type": "'range-area'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgRangeAreaSeriesOptionsKeys" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRangeAreaSeriesLabelFormatterParams": { "name": "AgRangeAreaSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yLowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yHighName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true } ] }, "AgRangeAreaSeriesLabelOptions": { "kind": "interface", "name": "AgRangeAreaSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Padding in pixels between the label and the edge of the marker." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Where to render series labels relative to the area." ], "name": "placement", "type": "AgRangeAreaSeriesLabelPlacement", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgRangeAreaSeriesLabelPlacement": { "kind": "typeAlias", "name": "AgRangeAreaSeriesLabelPlacement", "type": { "kind": "union", "type": [ "'inside'", "'outside'" ] } }, "AgRangeAreaSeriesOptions": { "kind": "interface", "name": "AgRangeAreaSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Range Area Series." ], "name": "type", "type": "'range-area'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Set to `true` to connect across missing data points." ], "name": "connectMissingData", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yLowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yHighName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgRangeAreaSeriesOptionsKeys" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgRangeAreaSeriesLabelOptions", "typeArguments": [ "TDatum", "AgRangeAreaSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgRangeAreaSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRangeAreaSeriesOptionsKeys": { "kind": "interface", "name": "AgRangeAreaSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRangeAreaSeriesOptionsNames": { "kind": "interface", "name": "AgRangeAreaSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yLowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yHighName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRangeAreaSeriesThemeOverrides": { "kind": "interface", "name": "AgRangeAreaSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgRangeAreaSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRangeAreaSeriesThemeableOptions": { "kind": "interface", "name": "AgRangeAreaSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the markers used in the series." ], "name": "marker", "type": { "kind": "typeRef", "type": "AgSeriesMarkerOptions", "typeArguments": [ "TDatum", "AgRangeAreaSeriesOptionsKeys" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the line used in the series." ], "name": "interpolation", "type": "AgInterpolationType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the range series items when they are hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgRangeAreaSeriesLabelOptions", "typeArguments": [ "TDatum", "AgRangeAreaSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgRangeAreaSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRangeAreaSeriesTooltipRendererParams": { "kind": "interface", "name": "AgRangeAreaSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "Hovered marker" ], "name": "itemId", "type": { "kind": "union", "type": [ "'up'", "'down'", "'unknown'" ] }, "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yLowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yHighName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRangeBarMiniChartSeriesOptions": { "kind": "interface", "name": "AgRangeBarMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Range Bar Series." ], "name": "type", "type": "'range-bar'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual RangeBar series item cells, based on the given parameters. If the current cell is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRangeBarSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRangeBarSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRangeBarSeriesItemStylerParams": { "name": "AgRangeBarSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false } ] }, "AgRangeBarSeriesLabelFormatterParams": { "name": "AgRangeBarSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yLowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yHighName", "type": "string", "optional": true } ] }, "AgRangeBarSeriesLabelOptions": { "kind": "interface", "name": "AgRangeBarSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Where to render series labels relative to the bars." ], "name": "placement", "type": "AgRangeBarSeriesLabelPlacement", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the label and the edge of the bar." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TParams": "AgRangeBarSeriesLabelFormatterParams" } }, "AgRangeBarSeriesLabelPlacement": { "kind": "typeAlias", "name": "AgRangeBarSeriesLabelPlacement", "type": { "kind": "union", "type": [ "'inside'", "'outside'" ] } }, "AgRangeBarSeriesOptions": { "kind": "interface", "name": "AgRangeBarSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Range Bar Series." ], "name": "type", "type": "'range-bar'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yLowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yHighName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction.", "", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRangeBarSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the range series items when they are hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgRangeBarSeriesLabelOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual RangeBar series item cells, based on the given parameters. If the current cell is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRangeBarSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRangeBarSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRangeBarSeriesOptionsKeys": { "kind": "interface", "name": "AgRangeBarSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRangeBarSeriesOptionsNames": { "kind": "interface", "name": "AgRangeBarSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yLowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yHighName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRangeBarSeriesStyle": { "kind": "interface", "name": "AgRangeBarSeriesStyle", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRangeBarSeriesThemeOverrides": { "kind": "interface", "name": "AgRangeBarSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgRangeBarSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgRangeBarSeriesThemeableOptions": { "kind": "interface", "name": "AgRangeBarSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Bar rendering direction.", "", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgRangeBarSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the range series items when they are hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgRangeBarSeriesLabelOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual RangeBar series item cells, based on the given parameters. If the current cell is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgRangeBarSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgRangeBarSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgRangeBarSeriesTooltipRendererParams": { "name": "AgRangeBarSeriesTooltipRendererParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-low-values from the data." ], "name": "yLowKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-high-values from the data." ], "name": "yHighKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yLowName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yHighName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgRangesButton": { "kind": "interface", "name": "AgRangesButton", "members": [ { "kind": "member", "docs": [ "Timestamp range on which to focus the chart, as either a single start time, a pair of times or a function that returns a pair of times." ], "name": "value", "type": "AgRangesButtonValue", "optional": false }, { "kind": "member", "docs": [ "Icon to display on the button." ], "name": "icon", "type": "AgIconName", "optional": true }, { "kind": "member", "docs": [ "Text label to display on the button." ], "name": "label", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Text label to announce in screen readers." ], "name": "ariaLabel", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Tooltip text to display on hover over the button." ], "name": "tooltip", "type": "string", "optional": true } ] }, "AgRangesButtonValue": { "kind": "typeAlias", "name": "AgRangesButtonValue", "type": { "kind": "union", "type": [ "number", "AgRangesButtonValuePair", "AgRangesButtonValueFunction" ] } }, "AgRangesButtonValueFunction": { "kind": "typeAlias", "name": "AgRangesButtonValueFunction", "type": { "kind": "function", "params": [ { "kind": "param", "name": "start", "type": { "kind": "union", "type": [ "Date", "number" ] } }, { "kind": "param", "name": "end", "type": { "kind": "union", "type": [ "Date", "number" ] } } ], "returnType": { "kind": "tuple", "type": [ { "kind": "union", "type": [ "Date", "number" ] }, { "kind": "union", "type": [ "Date", "number" ] } ] } } }, "AgRangesButtonValuePair": { "kind": "typeAlias", "name": "AgRangesButtonValuePair", "type": { "kind": "tuple", "type": [ { "kind": "union", "type": [ "Date", "number" ] }, { "kind": "union", "type": [ "Date", "number" ] } ] } }, "AgRangesOptions": { "kind": "interface", "name": "AgRangesOptions", "members": [ { "kind": "member", "name": "buttons", "type": { "kind": "array", "type": "AgRangesButton" }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ] }, "AgSankeySeriesLabelFormatterParams": { "kind": "interface", "name": "AgSankeySeriesLabelFormatterParams", "members": [ { "kind": "member", "name": "size", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "_TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "_TDatum": "any" } }, "AgSankeySeriesLabelOptions": { "kind": "interface", "name": "AgSankeySeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Spacing between a node and its label." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TParams": { "kind": "typeRef", "type": "AgSankeySeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } } }, "AgSankeySeriesLinkItemStylerParams": { "kind": "interface", "name": "AgSankeySeriesLinkItemStylerParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgSankeySeriesLinkOptions": { "kind": "interface", "name": "AgSankeySeriesLinkOptions", "members": [ { "kind": "member", "docs": [ "Function used to return formatting for individual links, based on the given parameters. If the current link is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgSankeySeriesLinkItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgSankeySeriesLinkStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgSankeySeriesLinkStyle": { "kind": "interface", "name": "AgSankeySeriesLinkStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgSankeySeriesNodeItemStylerParams": { "kind": "interface", "name": "AgSankeySeriesNodeItemStylerParams", "members": [ { "kind": "member", "docs": [ "Label of the node" ], "name": "label", "type": { "kind": "union", "type": [ "string", "undefined" ] }, "optional": false }, { "kind": "member", "docs": [ "Size of the node" ], "name": "size", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgSankeySeriesNodeOptions": { "kind": "interface", "name": "AgSankeySeriesNodeOptions", "members": [ { "kind": "member", "docs": [ "Minimum spacing between the nodes." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Width of the nodes." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Alignment of the nodes." ], "name": "alignment", "type": { "kind": "union", "type": [ "'left'", "'right'", "'center'", "'justify'" ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual nodes, based on the given parameters. If the current node is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgSankeySeriesNodeItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgSankeySeriesNodeStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgSankeySeriesNodeStyle": { "kind": "interface", "name": "AgSankeySeriesNodeStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgSankeySeriesOptions": { "kind": "interface", "name": "AgSankeySeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Sankey Series." ], "name": "type", "type": "'sankey'", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Options for the label for each node." ], "name": "label", "type": { "kind": "typeRef", "type": "AgSankeySeriesLabelOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the nodes and links." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the nodes and links." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Options for the links." ], "name": "link", "type": { "kind": "typeRef", "type": "AgSankeySeriesLinkOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for the nodes." ], "name": "node", "type": { "kind": "typeRef", "type": "AgSankeySeriesNodeOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgSankeySeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgSankeySeriesOptionsKeys": { "kind": "interface", "name": "AgSankeySeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSankeySeriesOptionsNames": { "kind": "interface", "name": "AgSankeySeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSankeySeriesThemeableOptions": { "kind": "interface", "name": "AgSankeySeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Options for the label for each node." ], "name": "label", "type": { "kind": "typeRef", "type": "AgSankeySeriesLabelOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the nodes and links." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the nodes and links." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Options for the links." ], "name": "link", "type": { "kind": "typeRef", "type": "AgSankeySeriesLinkOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for the nodes." ], "name": "node", "type": { "kind": "typeRef", "type": "AgSankeySeriesNodeOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgSankeySeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgSankeySeriesTooltipRendererParams": { "kind": "interface", "name": "AgSankeySeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "name": "size", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the start node of each link." ], "name": "fromKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the end node of each link." ], "name": "toKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key containing the size of each link." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSankeyThemeOverrides": { "kind": "interface", "name": "AgSankeyThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgSankeySeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgScatterMiniChartSeriesOptions": { "kind": "interface", "name": "AgScatterMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Scatter Series." ], "name": "type", "type": "'scatter'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgScatterSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgSeriesMarkerStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgScatterSeriesItemStylerParams": { "name": "AgScatterSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true } ] }, "AgScatterSeriesLabel": { "kind": "interface", "name": "AgScatterSeriesLabel", "members": [ { "kind": "member", "docs": [ "Placement of label in relation to the marker." ], "name": "placement", "type": "LabelPlacement", "optional": true, "defaultValue": "top" }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TParams": "AgScatterSeriesLabelFormatterParams" } }, "AgScatterSeriesLabelFormatterParams": { "name": "AgScatterSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ] }, "AgScatterSeriesOptions": { "kind": "interface", "name": "AgScatterSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Scatter Series." ], "name": "type", "type": "'scatter'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration for the Error Bars." ], "name": "errorBar", "type": { "kind": "typeRef", "type": "AgErrorBarOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgScatterSeriesLabel", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgScatterSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgScatterSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgSeriesMarkerStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgScatterSeriesOptionsKeys": { "kind": "interface", "name": "AgScatterSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgScatterSeriesOptionsNames": { "kind": "interface", "name": "AgScatterSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgScatterSeriesThemeOverrides": { "kind": "interface", "name": "AgScatterSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgScatterSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgScatterSeriesThemeableOptions": { "kind": "interface", "name": "AgScatterSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The title to use for the series. Defaults to `yName` if it exists, or `yKey` if not." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgScatterSeriesLabel", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgScatterSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgScatterSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgSeriesMarkerStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Error Bars." ], "name": "errorBar", "type": "AgErrorBarThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgScatterSeriesTooltipRendererParams": { "kind": "interface", "name": "AgScatterSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the label values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "labelName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the x axis data." ], "name": "xLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The x-axis lower bound error value." ], "name": "xLowerValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the x axis. This is the value to use in tooltips or labels." ], "name": "xLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the x axis data." ], "name": "xUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The x-axis upper bound error value." ], "name": "xUpperValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the x axis. This is the value to use in tooltips or labels." ], "name": "xUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the y axis data." ], "name": "yLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The y-axis lower bound error value." ], "name": "yLowerValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the y axis. This is the value to use in tooltips or labels." ], "name": "yLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the y axis data." ], "name": "yUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The y-axis upper bound error value." ], "name": "yUpperValue", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the y axis. This is the value to use in tooltips or labels." ], "name": "yUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSeriesAreaContextMenuActionEvent": { "name": "AgSeriesAreaContextMenuActionEvent", "kind": "interface", "members": [ { "kind": "member", "name": "type", "type": "T", "optional": false }, { "kind": "member", "name": "event", "type": "Event", "optional": false } ], "genericsMap": { "T": "'seriesContextMenuAction'" } }, "AgSeriesAreaOptions": { "kind": "interface", "name": "AgSeriesAreaOptions", "members": [ { "kind": "member", "docs": [ "Controls whether to strictly clip the series rendering to the series area." ], "name": "clip", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the padding around the series area." ], "name": "padding", "type": "AgSeriesAreaPaddingOptions", "optional": true } ] }, "AgSeriesAreaPaddingOptions": { "kind": "interface", "name": "AgSeriesAreaPaddingOptions", "members": [ { "kind": "member", "docs": [ "The number of pixels of padding at the top of the series area." ], "name": "top", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The number of pixels of padding at the right of the series area." ], "name": "right", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The number of pixels of padding at the bottom of the series area." ], "name": "bottom", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The number of pixels of padding at the left of the series area." ], "name": "left", "type": "PixelSize", "optional": true } ] }, "AgSeriesHighlightMarkerStyle": { "name": "AgSeriesHighlightMarkerStyle", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgSeriesHighlightSeriesStyle": { "kind": "interface", "name": "AgSeriesHighlightSeriesStyle", "members": [ { "kind": "member", "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The opacity of the whole series (area line, area fill, labels and markers, if any) when another chart series or another stack level in the same area series is highlighted by hovering a data point or a legend item. Use `undefined` or `1` for no dimming." ], "name": "dimOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The stroke width of the area line when one of the markers is tapped or hovered over, or when a tooltip is shown for a data point, even when series markers are disabled. Use `undefined` for no highlight." ], "name": "strokeWidth", "type": "PixelSize", "optional": true } ] }, "AgSeriesHighlightStyle": { "kind": "interface", "name": "AgSeriesHighlightStyle", "members": [ { "kind": "member", "docs": [ "Highlight style used for an individual item within a series." ], "name": "item", "type": "AgSeriesHighlightMarkerStyle", "optional": true }, { "kind": "member", "docs": [ "Highlight style used for whole series when a series or legend item is hovered." ], "name": "series", "type": "AgSeriesHighlightSeriesStyle", "optional": true } ] }, "AgSeriesListeners": { "kind": "interface", "name": "AgSeriesListeners", "members": [ { "kind": "member", "docs": [ "The listener to call when a node (marker, column, bar, tile or a pie sector) in the series is clicked." ], "name": "nodeClick", "type": { "kind": "typeRef", "type": "Listener", "typeArguments": [ { "kind": "typeRef", "type": "AgNodeClickEvent", "typeArguments": [ "'nodeClick'", "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "The listener to call when a node (marker, column, bar, tile or a pie sector) in the series is double-clicked." ], "name": "nodeDoubleClick", "type": { "kind": "typeRef", "type": "Listener", "typeArguments": [ { "kind": "typeRef", "type": "AgNodeClickEvent", "typeArguments": [ "'nodeDoubleClick'", "TDatum" ] } ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgSeriesMarkerOptions": { "kind": "interface", "name": "AgSeriesMarkerOptions", "members": [ { "kind": "member", "docs": [ "Whether to show markers." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgSeriesMarkerStylerParams", "typeArguments": [ "TDatum" ] }, "TParams" ] }, "AgSeriesMarkerStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "unknown" } }, "AgSeriesMarkerStyle": { "kind": "interface", "name": "AgSeriesMarkerStyle", "members": [ { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "unknown" } }, "AgSeriesMarkerStylerParams": { "name": "AgSeriesMarkerStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgSeriesTooltip": { "kind": "interface", "name": "AgSeriesTooltip", "members": [ { "kind": "member", "docs": [ "Whether to show tooltips when the series are hovered over." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The tooltip arrow is displayed by default, unless the container restricts it or a position offset is provided. To always display the arrow, set `showArrow` to `true`. To remove the arrow, set `showArrow` to `false`." ], "name": "showArrow", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Range from a point that triggers the tooltip to show. Each series type uses its own default; typically this is `'nearest'` for marker-based series and `'exact'` for shape-based series." ], "name": "range", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "The position of the tooltip. Each series type uses its own default; typically this is `'node'` for marker-based series and `'pointer'` for shape-based series." ], "name": "position", "type": "AgTooltipPositionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for tooltip interaction." ], "name": "interaction", "type": "AgSeriesTooltipInteraction", "optional": true }, { "kind": "member", "docs": [ "Function used to create the content for tooltips." ], "name": "renderer", "type": { "kind": "typeRef", "type": "Renderer", "typeArguments": [ "TParams", "AgTooltipRendererResult" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TParams", "constraint": "AgSeriesTooltipRendererParams", "default": null } ] }, "AgSeriesTooltipInteraction": { "kind": "interface", "name": "AgSeriesTooltipInteraction", "members": [ { "kind": "member", "docs": [ "Set to `true` to keep the tooltip open when the mouse is hovering over it, and enable clicking tooltip text" ], "name": "enabled", "type": "boolean", "optional": false } ] }, "AgSeriesTooltipRendererParams": { "kind": "interface", "name": "AgSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSeriesVisibilityChange": { "kind": "interface", "name": "AgSeriesVisibilityChange", "members": [ { "kind": "member", "docs": [ "Event type." ], "name": "type", "type": "'seriesVisibilityChange'", "optional": false }, { "kind": "member", "docs": [ "Series id" ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The new visibility status that the series is changing to." ], "name": "visible", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "Legend item id - usually yKey value for cartesian series." ], "name": "itemId", "type": { "kind": "union", "type": [ "string", "number" ] }, "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together." ], "name": "legendItemName", "type": "string", "optional": true } ] }, "AgShapeAnnotationStyles": { "kind": "interface", "name": "AgShapeAnnotationStyles", "members": [ { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ] }, "AgSparklineAxisOptions": { "kind": "typeAlias", "name": "AgSparklineAxisOptions", "type": { "kind": "union", "type": [ "AgSparklineCategoryAxisOptions", "AgSparklineNumberAxisOptions", "AgSparklineTimeAxisOptions" ] } }, "AgSparklineBaseAxisOptions": { "kind": "interface", "name": "AgSparklineBaseAxisOptions", "members": [ { "kind": "member", "docs": [ "Whether the axis should be shown." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis line." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis line." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true } ] }, "AgSparklineBaseCategoryAxisOptions": { "kind": "interface", "name": "AgSparklineBaseCategoryAxisOptions", "members": [ { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The padding on the outside i.e. left and right of the first and last category. In association with `paddingInner`, this value can be between 0 and 1." ], "name": "paddingOuter", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Whether the axis should be shown." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis line." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis line." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true } ] }, "AgSparklineBaseThemeableOptions": { "kind": "interface", "name": "AgSparklineBaseThemeableOptions", "members": [ { "kind": "member", "docs": [ "Context to use for tooltips." ], "name": "context", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Crosshair configurations." ], "name": "crosshair", "type": "AgSparklineCrosshairOptions", "optional": true }, { "kind": "member", "docs": [ "y-axis configurations." ], "name": "axis", "type": "AgSparklineAxisOptions", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Tooltip configuration." ], "name": "tooltip", "type": "AgSparklineTooltip", "optional": true } ] }, "AgSparklineCategoryAxisOptions": { "kind": "interface", "name": "AgSparklineCategoryAxisOptions", "members": [ { "kind": "member", "name": "type", "type": "'category'", "optional": false }, { "kind": "member", "docs": [ "The size of the gap between the categories as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band." ], "name": "paddingInner", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The padding on the outside i.e. left and right of the first and last category. In association with `paddingInner`, this value can be between 0 and 1." ], "name": "paddingOuter", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Whether the axis should be shown." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis line." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis line." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true } ] }, "AgSparklineContinuousAxisOptions": { "kind": "interface", "name": "AgSparklineContinuousAxisOptions", "members": [ { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": "Date | number", "default": null } ], "genericsMap": { "TDatum": "Date" } }, "AgSparklineCrosshairOptions": { "kind": "interface", "name": "AgSparklineCrosshairOptions", "members": [ { "kind": "member", "docs": [ "Whether to show the crosshair." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "When true, the crosshair snaps to the highlighted data point. By default this property is true." ], "name": "snap", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour of the stroke for the lines." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the lines." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "LabelType": "AgCrosshairLabel" } }, "AgSparklineDataKeysOptions": { "kind": "interface", "name": "AgSparklineDataKeysOptions", "members": [ { "kind": "member", "name": "xKey", "type": "string", "optional": true }, { "kind": "member", "name": "yKey", "type": "string", "optional": true } ] }, "AgSparklineNumberAxisOptions": { "kind": "interface", "name": "AgSparklineNumberAxisOptions", "members": [ { "kind": "member", "name": "type", "type": "'number'", "optional": false }, { "kind": "member", "docs": [ "Whether the axis should be shown." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis line." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis line." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true } ], "genericsMap": { "TDatum": "number" } }, "AgSparklineOptions": { "name": "AgSparklineOptions", "kind": "interface", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Context to use for tooltips." ], "name": "context", "type": "any", "optional": true }, { "kind": "member", "docs": [ "Crosshair configurations." ], "name": "crosshair", "type": "AgSparklineCrosshairOptions", "optional": true }, { "kind": "member", "docs": [ "y-axis configurations." ], "name": "axis", "type": "AgSparklineAxisOptions", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "number", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "number", "optional": true }, { "kind": "member", "docs": [ "Tooltip configuration." ], "name": "tooltip", "type": "AgSparklineTooltip", "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgSparklinePresets": { "kind": "typeAlias", "name": "AgSparklinePresets", "type": { "kind": "union", "type": [ "AgBarSparklinePreset", "AgLineSparklinePreset", "AgAreaSparklinePreset" ] }, "genericsMap": { "TDatum": "any" } }, "AgSparklineTimeAxisOptions": { "kind": "interface", "name": "AgSparklineTimeAxisOptions", "members": [ { "kind": "member", "name": "type", "type": "'time'", "optional": false }, { "kind": "member", "docs": [ "Whether the axis should be shown." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour of the axis line." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the axis line." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true } ], "genericsMap": { "TDatum": "Date" } }, "AgSparklineTooltip": { "kind": "interface", "name": "AgSparklineTooltip", "members": [ { "kind": "member", "docs": [ "Whether to show tooltips when the series are hovered over." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The tooltip arrow is displayed by default, unless the container restricts it or a position offset is provided. To always display the arrow, set `showArrow` to `true`. To remove the arrow, set `showArrow` to `false`." ], "name": "showArrow", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Range from a point that triggers the tooltip to show. Each series type uses its own default; typically this is `'nearest'` for marker-based series and `'exact'` for shape-based series." ], "name": "range", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "The position of the tooltip. Each series type uses its own default; typically this is `'node'` for marker-based series and `'pointer'` for shape-based series." ], "name": "position", "type": "AgTooltipPositionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for tooltip interaction." ], "name": "interaction", "type": "AgSeriesTooltipInteraction", "optional": true }, { "kind": "member", "docs": [ "Function used to create the content for tooltips." ], "name": "renderer", "type": { "kind": "typeRef", "type": "Renderer", "typeArguments": [ { "kind": "typeRef", "type": "AgSparklineTooltipRendererParams", "typeArguments": [ "TDatum" ] }, "AgSparklineTooltipRendererResult" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgSparklineTooltipRendererParams": { "kind": "interface", "name": "AgSparklineTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "Context passed into the Sparkline options, if provided." ], "name": "context", "type": "any", "optional": false }, { "kind": "member", "docs": [ "Value of the datum." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "Value of the datum against the x-axis." ], "name": "xValue", "type": "any", "optional": false }, { "kind": "member", "docs": [ "Value of the datum against the y-axis." ], "name": "yValue", "type": "any", "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgSparklineTooltipRendererResult": { "kind": "interface", "name": "AgSparklineTooltipRendererResult", "members": [ { "kind": "member", "docs": [ "* The title of the tooltip." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "* The content to display in each tooltip." ], "name": "content", "type": "string", "optional": true } ] }, "AgStandaloneChartOptions": { "kind": "interface", "name": "AgStandaloneChartOptions", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgStandaloneSeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgStandaloneSeriesOptions": { "kind": "typeAlias", "name": "AgStandaloneSeriesOptions", "type": "AgPyramidSeriesOptions" }, "AgStateSerializableDate": { "kind": "interface", "name": "AgStateSerializableDate", "members": [ { "kind": "member", "name": "__type", "type": "'date'", "optional": false }, { "kind": "member", "name": "value", "type": { "kind": "union", "type": [ "string", "number" ] }, "optional": false } ] }, "AgSunburstSeriesHighlightStyle": { "kind": "interface", "name": "AgSunburstSeriesHighlightStyle", "members": [ { "kind": "member", "docs": [ "Options for the label in a sector." ], "name": "label", "type": { "kind": "typeRef", "type": "AgSunburstSeriesLabelHighlightOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for a secondary, smaller label in a sector - displayed under the primary label." ], "name": "secondaryLabel", "type": { "kind": "typeRef", "type": "AgSunburstSeriesLabelHighlightOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgSunburstSeriesItemStylerParams": { "kind": "interface", "name": "AgSunburstSeriesItemStylerParams", "members": [ { "kind": "member", "docs": [ "The depth of the datum in the hierarchy." ], "name": "depth", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "docs": [ "The parameters of the Sunburst series formatter function" ] }, "AgSunburstSeriesLabelFormatterParams": { "kind": "interface", "name": "AgSunburstSeriesLabelFormatterParams", "members": [ { "kind": "member", "docs": [ "The depth of the datum in the hierarchy." ], "name": "depth", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "_TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "_TDatum": "any" } }, "AgSunburstSeriesLabelHighlightOptions": { "name": "AgSunburstSeriesLabelHighlightOptions", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true } ], "genericsMap": { "TDatum": "TDatum", "TParams": { "kind": "typeRef", "type": "AgSunburstSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } } }, "AgSunburstSeriesOptions": { "kind": "interface", "name": "AgSunburstSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Sunburst Series." ], "name": "type", "type": "'sunburst'", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Options for the label in a sector." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartAutoSizedLabelOptions", "typeArguments": [ "TDatum", { "kind": "typeRef", "type": "AgSunburstSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Options for a secondary, smaller label in a sector - displayed under the primary label." ], "name": "secondaryLabel", "type": { "kind": "typeRef", "type": "AgChartAutoSizedSecondaryLabelOptions", "typeArguments": [ "TDatum", { "kind": "typeRef", "type": "AgSunburstSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Spacing between the sectors." ], "name": "sectorSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Minimum distance between text and the edges of the sectors." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the sectors." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the sectors." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the sectors." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the sectors." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the sectors." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into." ], "name": "colorRange", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgSunburstSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular Sunburst sector based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgSunburstSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgSunburstSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgSunburstSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSunburstSeriesOptionsKeys": { "kind": "interface", "name": "AgSunburstSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSunburstSeriesOptionsNames": { "kind": "interface", "name": "AgSunburstSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSunburstSeriesStyle": { "name": "AgSunburstSeriesStyle", "docs": [ "The formatted style of a Sunburst sector." ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgSunburstSeriesThemeOverrides": { "kind": "interface", "name": "AgSunburstSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgSunburstSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgSunburstSeriesThemeableOptions": { "kind": "interface", "name": "AgSunburstSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Options for the label in a sector." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartAutoSizedLabelOptions", "typeArguments": [ "TDatum", { "kind": "typeRef", "type": "AgSunburstSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Options for a secondary, smaller label in a sector - displayed under the primary label." ], "name": "secondaryLabel", "type": { "kind": "typeRef", "type": "AgChartAutoSizedSecondaryLabelOptions", "typeArguments": [ "TDatum", { "kind": "typeRef", "type": "AgSunburstSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each sector." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Spacing between the sectors." ], "name": "sectorSpacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Minimum distance between text and the edges of the sectors." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the sectors." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the sectors." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill for the sectors." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke for the sectors." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the stroke for the sectors." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into." ], "name": "colorRange", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgSunburstSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular Sunburst sector based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgSunburstSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgSunburstSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgSunburstSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgSunburstSeriesTooltipRendererParams": { "kind": "interface", "name": "AgSunburstSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The depth of the datum in the hierarchy." ], "name": "depth", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the segment colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgTextAnnotation": { "kind": "interface", "name": "AgTextAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the text annotation." ], "name": "type", "type": "'text'", "optional": false }, { "kind": "member", "docs": [ "The text content." ], "name": "text", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The x-value of the point." ], "name": "x", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "The y-value of the point." ], "name": "y", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "AgTextAnnotationStyles": { "kind": "interface", "name": "AgTextAnnotationStyles", "members": [ { "kind": "member", "name": "handle", "type": "AgAnnotationHandleStyles", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true } ] }, "AgThemeOverrides": { "kind": "interface", "name": "AgThemeOverrides", "members": [ { "kind": "member", "docs": [ "Common theme overrides for series." ], "name": "common", "type": "AgCommonThemeableChartOptions", "optional": true }, { "kind": "member", "docs": [ "Line series theme overrides." ], "name": "line", "type": "AgLineSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Scatter series theme overrides." ], "name": "scatter", "type": "AgScatterSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Bubble series theme overrides." ], "name": "bubble", "type": "AgBubbleSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Area series theme overrides." ], "name": "area", "type": "AgAreaSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Bar series theme overrides." ], "name": "bar", "type": "AgBarSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Box-plot series theme overrides." ], "name": "'box-plot'", "type": "AgBoxPlotSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Candlestick series theme overrides." ], "name": "candlestick", "type": "AgCandlestickSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Cone Funnel series theme overrides." ], "name": "'cone-funnel'", "type": "AgConeFunnelSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Funnel series theme overrides." ], "name": "funnel", "type": "AgFunnelSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "ohlc series theme overrides." ], "name": "ohlc", "type": "AgOhlcSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Histogram series theme overrides." ], "name": "histogram", "type": "AgHistogramSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Heatmap series theme overrides." ], "name": "heatmap", "type": "AgHeatmapSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Waterfall series theme overrides." ], "name": "waterfall", "type": "AgWaterfallSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Range-bar series theme overrides." ], "name": "'range-bar'", "type": "AgRangeBarSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Range-area series theme overrides." ], "name": "'range-area'", "type": "AgRangeAreaSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Donut series theme overrides." ], "name": "donut", "type": "AgDonutSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Pie series theme overrides." ], "name": "pie", "type": "AgPieSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radar-line series theme overrides." ], "name": "'radar-line'", "type": "AgRadarLineSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radar-area series theme overrides." ], "name": "'radar-area'", "type": "AgRadarAreaSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radial-bar series theme overrides." ], "name": "'radial-bar'", "type": "AgRadialBarSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radial-column series theme overrides." ], "name": "'radial-column'", "type": "AgRadialColumnSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Nightingale series theme overrides." ], "name": "nightingale", "type": "AgNightingaleSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Sunburst series theme overrides." ], "name": "sunburst", "type": "AgSunburstSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Treemap series theme overrides." ], "name": "treemap", "type": "AgTreemapSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map shape series theme overrides." ], "name": "'map-shape'", "type": "AgMapShapeSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map line series theme overrides." ], "name": "'map-line'", "type": "AgMapLineSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map marker series theme overrides." ], "name": "'map-marker'", "type": "AgMapMarkerSeriesThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map shape background series theme overrides." ], "name": "'map-shape-background'", "type": "AgMapShapeBackgroundThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Map line background series theme overrides." ], "name": "'map-line-background'", "type": "AgMapLineBackgroundThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Sankey series theme overrides." ], "name": "sankey", "type": "AgSankeyThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Chord series theme overrides." ], "name": "chord", "type": "AgChordThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Pyramid series theme overrides." ], "name": "pyramid", "type": "AgPyramidThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Radial gauge theme overrides." ], "name": "'radial-gauge'", "type": "AgRadialGaugeThemeOverrides", "optional": true }, { "kind": "member", "docs": [ "Linear Gauge theme overrides." ], "name": "'linear-gauge'", "type": "AgLinearGaugeThemeOverrides", "optional": true } ] }, "AgTimeAxisOptions": { "kind": "interface", "name": "AgTimeAxisOptions", "members": [ { "kind": "member", "docs": [ "Axis type identifier." ], "name": "type", "type": "'time'", "optional": false }, { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "Add cross lines or regions corresponding to data values." ], "name": "crossLines", "type": { "kind": "array", "type": "AgCartesianCrossLineOptions" }, "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": { "kind": "union", "type": [ "Date", "number" ] }, "TInterval": { "kind": "union", "type": [ "TimeInterval", "number" ] } } }, "AgTimeAxisThemeOptions": { "kind": "interface", "name": "AgTimeAxisThemeOptions", "members": [ { "kind": "member", "docs": [ "An array of keys determining which series are charted on this axis." ], "name": "keys", "type": { "kind": "array", "type": "string" }, "optional": true }, { "kind": "member", "docs": [ "The position on the chart where the axis should be rendered." ], "name": "position", "type": "AgCartesianAxisPosition", "optional": true }, { "kind": "member", "docs": [ "If set to a non-zero value, the axis will have the specified thickness regardless of label size." ], "name": "thickness", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown next to the axis." ], "name": "title", "type": "AgAxisCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis crosshair." ], "name": "crosshair", "type": { "kind": "typeRef", "type": "AgCrosshairOptions", "typeArguments": [ "CrosshairLabelType" ] }, "optional": true }, { "kind": "member", "docs": [ "Reverse the axis scale domain if `true`." ], "name": "reverse", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis line." ], "name": "line", "type": "AgAxisLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis grid lines." ], "name": "gridLine", "type": "AgAxisGridLineOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis labels, shown next to the ticks." ], "name": "label", "type": "LabelType", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks." ], "name": "tick", "type": "AgAxisBaseTickOptions", "optional": true }, { "kind": "member", "docs": [ "If `true`, the range will be rounded up to ensure nice equal spacing between the ticks." ], "name": "nice", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined min value (based on series data)." ], "name": "min", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "User override for the automatically determined max value (based on series data)." ], "name": "max", "type": "TDatum", "optional": true }, { "kind": "member", "docs": [ "Configuration for the axis ticks interval." ], "name": "interval", "type": { "kind": "typeRef", "type": "AgAxisContinuousIntervalOptions", "typeArguments": [ "TInterval" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `top` positioned axes. Same configs apply here as one level above. For example, to rotate labels by 45 degrees in 'top' positioned axes one can use `top: { label: { rotation: 45 } } }`." ], "name": "top", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `right` positioned axes. Same configs apply here as one level above." ], "name": "right", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `bottom` positioned axes. Same configs apply here as one level above." ], "name": "bottom", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "docs": [ "An object with axis theme overrides for the `left` positioned axes. Same configs apply here as one level above." ], "name": "left", "type": { "kind": "typeRef", "type": "Omit", "typeArguments": [ "T", "AgCartesianAxisThemeSpecialOptions" ] }, "optional": true }, { "kind": "member", "name": "crossLines", "type": "AgCrossLineThemeOptions", "optional": true } ], "genericsMap": { "LabelType": "AgCartesianAxisLabelOptions", "CrosshairLabelType": "AgCrosshairLabel", "TDatum": { "kind": "union", "type": [ "Date", "number" ] }, "TInterval": { "kind": "union", "type": [ "TimeInterval", "number" ] }, "T": "AgTimeAxisOptions" } }, "AgTooltipAnchorTo": { "kind": "typeAlias", "name": "AgTooltipAnchorTo", "type": "AgTooltipAnchorToType" }, "AgTooltipAnchorToType": { "kind": "typeAlias", "name": "AgTooltipAnchorToType", "type": { "kind": "union", "type": [ "'pointer'", "'node'", "'chart'" ] } }, "AgTooltipMode": { "kind": "typeAlias", "name": "AgTooltipMode", "type": { "kind": "union", "type": [ "'single'", "'shared'", "'compact'" ] } }, "AgTooltipPlacement": { "kind": "typeAlias", "name": "AgTooltipPlacement", "type": "AgTooltipPlacementType" }, "AgTooltipPlacementType": { "kind": "typeAlias", "name": "AgTooltipPlacementType", "type": { "kind": "union", "type": [ "'top'", "'right'", "'bottom'", "'left'", "'top-right'", "'bottom-right'", "'bottom-left'", "'top-left'", "'center'" ] } }, "AgTooltipPositionOptions": { "kind": "interface", "name": "AgTooltipPositionOptions", "members": [ { "kind": "member", "docs": [ "The element or point to position the tooltip relative to." ], "name": "anchorTo", "type": "AgTooltipAnchorTo", "optional": true }, { "kind": "member", "docs": [ "The positioning of the tooltip in relation to the element it's anchored to. Multiple values can be provided as a fallback mechanism for the case the tooltip does not fit inside the chart." ], "name": "placement", "type": { "kind": "union", "type": [ "AgTooltipPlacement", { "kind": "array", "type": "AgTooltipPlacement" } ] }, "optional": true }, { "kind": "member", "docs": [ "The horizontal offset in pixels for the position of the tooltip." ], "name": "xOffset", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The vertical offset in pixels for the position of the tooltip." ], "name": "yOffset", "type": "PixelSize", "optional": true } ] }, "AgTooltipPositionType": { "kind": "typeAlias", "name": "AgTooltipPositionType", "type": { "kind": "union", "type": [ "'pointer'", "'node'", "'top'", "'right'", "'bottom'", "'left'", "'top-left'", "'top-right'", "'bottom-right'", "'bottom-left'" ] } }, "AgTooltipRendererDataRow": { "kind": "interface", "name": "AgTooltipRendererDataRow", "members": [ { "kind": "member", "name": "label", "type": "string", "optional": false }, { "kind": "member", "name": "value", "type": "string", "optional": false } ] }, "AgTooltipRendererResult": { "kind": "interface", "name": "AgTooltipRendererResult", "members": [ { "kind": "member", "docs": [ "Text for the tooltip header." ], "name": "heading", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Text for the tooltip title." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "An array of text for the tooltip body." ], "name": "data", "type": { "kind": "array", "type": "AgTooltipRendererDataRow" }, "optional": true } ] }, "AgTopologyChartOptions": { "kind": "interface", "name": "AgTopologyChartOptions", "members": [ { "kind": "member", "name": "theme", "type": { "kind": "union", "type": [ "AgChartTheme", "AgChartThemeName" ] }, "optional": true }, { "kind": "member", "docs": [ "Series configurations." ], "name": "series", "type": { "kind": "array", "type": "AgTopologySeriesOptions" }, "optional": true }, { "kind": "member", "docs": [ "Topology to use in all series." ], "name": "topology", "type": "GeoJSON", "optional": true }, { "kind": "member", "docs": [ "The data to render the chart from. If this is not specified, it must be set on individual series instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "The element to place the rendered chart into." ], "name": "container", "type": { "kind": "union", "type": [ "HTMLElement", "null" ] }, "optional": true }, { "kind": "member", "docs": [ "The initial state of the chart. This must be a serializable value." ], "name": "initialState", "type": "AgInitialStateOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgTopologySeriesOptions": { "kind": "typeAlias", "name": "AgTopologySeriesOptions", "type": { "kind": "union", "type": [ "AgMapShapeSeriesOptions", "AgMapLineSeriesOptions", "AgMapMarkerSeriesOptions", "AgMapShapeBackgroundOptions", "AgMapLineBackgroundOptions" ] } }, "AgTouchOptions": { "kind": "interface", "name": "AgTouchOptions", "members": [ { "kind": "member", "docs": [ "Sets the input handling behavior for single-finger touch drag events.", "", "- `'none'` - ignores these events, typically causing the default page-scrolling behavior.", "- `'hover'` - makes these behave like mouse hover events, showing tooltip and crosshairs.", "- `'drag'` - makes these behave like mouse drag events (moving while holding left-button)." ], "name": "dragAction", "type": { "kind": "union", "type": [ "'none'", "'drag'", "'hover'" ] }, "optional": true, "defaultValue": "'drag'" } ] }, "AgTreemapSeriesGroupHighlightStyle": { "kind": "interface", "name": "AgTreemapSeriesGroupHighlightStyle", "members": [ { "kind": "member", "docs": [ "Options for the label in a group." ], "name": "label", "type": { "kind": "typeRef", "type": "AgTreemapSeriesLabelHighlightOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgTreemapSeriesGroupLabelOptions": { "kind": "interface", "name": "AgTreemapSeriesGroupLabelOptions", "members": [ { "kind": "member", "docs": [ "The distance between the tiles and the title." ], "name": "spacing", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TParams": { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } } }, "AgTreemapSeriesGroupLayout": { "kind": "interface", "name": "AgTreemapSeriesGroupLayout", "members": [ { "kind": "member", "docs": [ "Options for the label in a group." ], "name": "label", "type": { "kind": "typeRef", "type": "AgTreemapSeriesGroupLabelOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the label." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "The distance between the edges of the outer-most title to the edges of the group." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Gap between adjacent groups." ], "name": "gap", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether the group can be highlighted." ], "name": "interactive", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgTreemapSeriesGroupOptions": { "kind": "interface", "name": "AgTreemapSeriesGroupOptions", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each group." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Options for the label in a group." ], "name": "label", "type": { "kind": "typeRef", "type": "AgTreemapSeriesGroupLabelOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the label." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "The distance between the edges of the outer-most title to the edges of the group." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Gap between adjacent groups." ], "name": "gap", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Whether the group can be highlighted." ], "name": "interactive", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgTreemapSeriesGroupStyle": { "kind": "interface", "name": "AgTreemapSeriesGroupStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgTreemapSeriesHighlightStyle": { "kind": "interface", "name": "AgTreemapSeriesHighlightStyle", "members": [ { "kind": "member", "docs": [ "Options for the label in a tile." ], "name": "group", "type": { "kind": "typeRef", "type": "AgTreemapSeriesGroupHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for a secondary, smaller label in a tile - displayed under the primary label." ], "name": "tile", "type": { "kind": "typeRef", "type": "AgTreemapSeriesTileHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgTreemapSeriesItemStylerParams": { "kind": "interface", "name": "AgTreemapSeriesItemStylerParams", "members": [ { "kind": "member", "docs": [ "The depth of the datum in the hierarchy." ], "name": "depth", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the tile colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "docs": [ "The parameters of the Treemap series formatter function." ] }, "AgTreemapSeriesLabelFormatterParams": { "kind": "interface", "name": "AgTreemapSeriesLabelFormatterParams", "members": [ { "kind": "member", "docs": [ "The depth of the datum in the hierarchy." ], "name": "depth", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the tile colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "_TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "_TDatum": "any" } }, "AgTreemapSeriesLabelHighlightOptions": { "name": "AgTreemapSeriesLabelHighlightOptions", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true } ], "genericsMap": { "TDatum": "TDatum", "TParams": { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } } }, "AgTreemapSeriesOptions": { "kind": "interface", "name": "AgTreemapSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Treemap Series." ], "name": "type", "type": "'treemap'", "optional": false }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the tile colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the fills of the groups and tiles." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the groups and tiles." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into." ], "name": "colorRange", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Options for group nodes (i.e. nodes WITH children)." ], "name": "group", "type": { "kind": "typeRef", "type": "AgTreemapSeriesGroupOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for leaf nodes (i.e. nodes WITHOUT children)." ], "name": "tile", "type": { "kind": "typeRef", "type": "AgTreemapSeriesTileOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgTreemapSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular tile based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgTreemapSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgTreemapSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgTreemapSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgTreemapSeriesOptionsKeys": { "kind": "interface", "name": "AgTreemapSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the tile colour." ], "name": "colorKey", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgTreemapSeriesOptionsNames": { "kind": "interface", "name": "AgTreemapSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgTreemapSeriesStyle": { "kind": "interface", "name": "AgTreemapSeriesStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "docs": [ "The formatted style of a Treemap tile." ] }, "AgTreemapSeriesThemeOverrides": { "kind": "interface", "name": "AgTreemapSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgTreemapSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgTreemapSeriesThemeableOptions": { "kind": "interface", "name": "AgTreemapSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "The colours to cycle through for the fills of the groups and tiles." ], "name": "fills", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colours to cycle through for the strokes of the groups and tiles." ], "name": "strokes", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "The colour range to interpolate the numeric colour domain (min and max `colorKey` values) into." ], "name": "colorRange", "type": { "kind": "array", "type": "CssColor" }, "optional": true }, { "kind": "member", "docs": [ "Options for group nodes (i.e. nodes WITH children)." ], "name": "group", "type": { "kind": "typeRef", "type": "AgTreemapSeriesGroupOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for leaf nodes (i.e. nodes WITHOUT children)." ], "name": "tile", "type": { "kind": "typeRef", "type": "AgTreemapSeriesTileOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ { "kind": "typeRef", "type": "AgTreemapSeriesTooltipRendererParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "A callback function for adjusting the styles of a particular tile based on the input parameters." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgTreemapSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgTreemapSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Style overrides when a node is hovered." ], "name": "highlightStyle", "type": { "kind": "typeRef", "type": "AgTreemapSeriesHighlightStyle", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgTreemapSeriesTileHighlightStyle": { "kind": "interface", "name": "AgTreemapSeriesTileHighlightStyle", "members": [ { "kind": "member", "docs": [ "Options for the label in a tile." ], "name": "label", "type": { "kind": "typeRef", "type": "AgTreemapSeriesLabelHighlightOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Options for a secondary, smaller label in a tile - displayed under the primary label." ], "name": "secondaryLabel", "type": { "kind": "typeRef", "type": "AgTreemapSeriesLabelHighlightOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgTreemapSeriesTileLayout": { "kind": "interface", "name": "AgTreemapSeriesTileLayout", "members": [ { "kind": "member", "docs": [ "Options for the label in a tile." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartAutoSizedLabelOptions", "typeArguments": [ "TDatum", { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Options for a secondary, smaller label in a tile - displayed under the primary label." ], "name": "secondaryLabel", "type": { "kind": "typeRef", "type": "AgChartAutoSizedSecondaryLabelOptions", "typeArguments": [ "TDatum", { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the label." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "Vertical position of the label." ], "name": "verticalAlign", "type": "VerticalAlign", "optional": true }, { "kind": "member", "docs": [ "Distance between the tile edges and the text." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Gap between adjacent tile." ], "name": "gap", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgTreemapSeriesTileOptions": { "kind": "interface", "name": "AgTreemapSeriesTileOptions", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each tile." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Options for the label in a tile." ], "name": "label", "type": { "kind": "typeRef", "type": "AgChartAutoSizedLabelOptions", "typeArguments": [ "TDatum", { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Options for a secondary, smaller label in a tile - displayed under the primary label." ], "name": "secondaryLabel", "type": { "kind": "typeRef", "type": "AgChartAutoSizedSecondaryLabelOptions", "typeArguments": [ "TDatum", { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Horizontal position of the label." ], "name": "textAlign", "type": "TextAlign", "optional": true }, { "kind": "member", "docs": [ "Vertical position of the label." ], "name": "verticalAlign", "type": "VerticalAlign", "optional": true }, { "kind": "member", "docs": [ "Distance between the tile edges and the text." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Gap between adjacent tile." ], "name": "gap", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgTreemapSeriesTileStyle": { "kind": "interface", "name": "AgTreemapSeriesTileStyle", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ] }, "AgTreemapSeriesTooltipRendererParams": { "kind": "interface", "name": "AgTreemapSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The depth of the datum in the hierarchy." ], "name": "depth", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the label." ], "name": "labelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing a secondary label." ], "name": "secondaryLabelKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the children. Defaults to `children`." ], "name": "childrenKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the size value." ], "name": "sizeKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The name of the node key containing the colour value. This value (along with `colorRange` config) will be used to determine the tile colour." ], "name": "colorKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the size values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "sizeName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the colour values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "colorName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "TDatum" } }, "AgVerticalLineAnnotation": { "kind": "interface", "name": "AgVerticalLineAnnotation", "members": [ { "kind": "member", "docs": [ "Configuration for the vertical-line annotation." ], "name": "type", "type": "'vertical-line'", "optional": false }, { "kind": "member", "docs": [ "Position of the annotation specified in terms of the axis values." ], "name": "value", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "Configuration for the line text." ], "name": "text", "type": "AgLineAnnotationText", "optional": true }, { "kind": "member", "docs": [ "Configuration for the annotation axis label." ], "name": "axisLabel", "type": "AgAnnotationAxisLabel", "optional": true }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgWaterfallMiniChartSeriesOptions": { "kind": "interface", "name": "AgWaterfallMiniChartSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Waterfall Series." ], "name": "type", "type": "'waterfall'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration of total and subtotal values." ], "name": "totals", "type": { "kind": "array", "type": "WaterfallSeriesTotalMeta" }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the waterfall series item types." ], "name": "item", "type": { "kind": "typeRef", "type": "AgWaterfallSeriesItem", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the connector lines." ], "name": "line", "type": "AgWaterfallSeriesLineOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgWaterfallSeriesItem": { "kind": "interface", "name": "AgWaterfallSeriesItem", "members": [ { "kind": "member", "docs": [ "Configuration for the negative series items." ], "name": "negative", "type": { "kind": "typeRef", "type": "AgWaterfallSeriesItemOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the positive series items." ], "name": "positive", "type": { "kind": "typeRef", "type": "AgWaterfallSeriesItemOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the total and subtotal series items." ], "name": "total", "type": { "kind": "typeRef", "type": "AgWaterfallSeriesItemOptions", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgWaterfallSeriesItemOptions": { "kind": "interface", "name": "AgWaterfallSeriesItemOptions", "members": [ { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the legend and default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "name", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for the labels shown on top of data points." ], "name": "label", "type": { "kind": "typeRef", "type": "AgWaterfallSeriesLabelOptions", "typeArguments": [ "TDatum", "AgWaterfallSeriesLabelFormatterParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the shadow used behind the series items." ], "name": "shadow", "type": "AgDropShadowOptions", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual Waterfall series item cells, based on the given parameters. If the current cell is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgWaterfallSeriesItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgWaterfallSeriesStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "Series item specific tooltip configuration." ], "name": "tooltip", "type": "AgWaterfallSeriesItemTooltip", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "AgWaterfallSeriesItemStylerParams": { "name": "AgWaterfallSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The unique identifier of the item." ], "name": "itemId", "type": "ItemType", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false } ], "genericsMap": { "ItemType": "AgWaterfallSeriesItemType" } }, "AgWaterfallSeriesItemTooltip": { "kind": "interface", "name": "AgWaterfallSeriesItemTooltip", "members": [ { "kind": "member", "docs": [ "Function used to create the content for tooltips." ], "name": "renderer", "type": { "kind": "typeRef", "type": "Renderer", "typeArguments": [ "AgWaterfallSeriesTooltipRendererParams", "AgTooltipRendererResult" ] }, "optional": true } ] }, "AgWaterfallSeriesItemType": { "kind": "typeAlias", "name": "AgWaterfallSeriesItemType", "type": { "kind": "union", "type": [ "'positive'", "'negative'", "'total'", "'subtotal'" ] } }, "AgWaterfallSeriesLabelFormatterParams": { "name": "AgWaterfallSeriesLabelFormatterParams", "kind": "interface", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "name": "itemId", "type": "AgWaterfallSeriesItemType", "optional": false }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true } ] }, "AgWaterfallSeriesLabelOptions": { "kind": "interface", "name": "AgWaterfallSeriesLabelOptions", "members": [ { "kind": "member", "docs": [ "Where to render series labels relative to the bars." ], "name": "placement", "type": "AgWaterfallSeriesLabelPlacement", "optional": true }, { "kind": "member", "docs": [ "Padding in pixels between the label and the edge of the bar." ], "name": "padding", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A custom formatting function used to convert data values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgChartLabelFormatterParams", "typeArguments": [ "TDatum" ] }, "TParams" ] } ] }, "optional": true }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null }, { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ] }, "AgWaterfallSeriesLabelPlacement": { "kind": "typeAlias", "name": "AgWaterfallSeriesLabelPlacement", "type": { "kind": "union", "type": [ "'inside-center'", "'inside-start'", "'inside-end'", "'outside-start'", "'outside-end'" ] } }, "AgWaterfallSeriesLineOptions": { "kind": "interface", "name": "AgWaterfallSeriesLineOptions", "members": [ { "kind": "member", "docs": [ "Whether the connector lines should be shown." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour to use for the connector lines." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width in pixels of the connector lines." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Opacity of the line stroke." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "Defines how the strokes are rendered. Every number in the array specifies the length in pixels of alternating dashes and gaps. For example, `[6, 3]` means dashes with a length of `6` pixels with gaps between of `3` pixels." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "AgWaterfallSeriesOptions": { "kind": "interface", "name": "AgWaterfallSeriesOptions", "members": [ { "kind": "member", "docs": [ "Configuration for the Waterfall Series." ], "name": "type", "type": "'waterfall'", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration of total and subtotal values." ], "name": "totals", "type": { "kind": "array", "type": "WaterfallSeriesTotalMeta" }, "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Configuration for marker and series highlighting when a series or legend item is hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Bar rendering direction.", "", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the waterfall series item types." ], "name": "item", "type": { "kind": "typeRef", "type": "AgWaterfallSeriesItem", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the connector lines." ], "name": "line", "type": "AgWaterfallSeriesLineOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgWaterfallSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgWaterfallSeriesOptionsKeys": { "kind": "interface", "name": "AgWaterfallSeriesOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "any" } }, "AgWaterfallSeriesOptionsNames": { "kind": "interface", "name": "AgWaterfallSeriesOptionsNames", "members": [ { "kind": "member", "docs": [ "A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "yName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgWaterfallSeriesStyle": { "kind": "interface", "name": "AgWaterfallSeriesStyle", "members": [ { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "genericsMap": { "TDatum": "TDatum" } }, "AgWaterfallSeriesThemeOverrides": { "kind": "interface", "name": "AgWaterfallSeriesThemeOverrides", "members": [ { "kind": "member", "name": "series", "type": "AgWaterfallSeriesThemeableOptions", "optional": true }, { "kind": "member", "docs": [ "Axis configurations." ], "name": "axes", "type": "AgCartesianAxesTheme", "optional": true }, { "kind": "member", "docs": [ "The width of the chart in pixels." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The height of the chart in pixels." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Sets the minimum height of the chart. Ignored if `height` is specified." ], "name": "minHeight", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Sets the minimum width of the chart. Ignored if `width` is specified." ], "name": "minWidth", "type": "PixelSize", "optional": true, "defaultValue": "300" }, { "kind": "member", "docs": [ "Configuration for the padding shown around the chart." ], "name": "padding", "type": "AgChartPaddingOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration relating to the series area." ], "name": "seriesArea", "type": "AgSeriesAreaOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the background shown behind the chart." ], "name": "background", "type": "AgChartBackground", "optional": true }, { "kind": "member", "docs": [ "Configuration for the title shown at the top of the chart." ], "name": "title", "type": "AgChartCaptionOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the subtitle shown beneath the chart title.", "__Note:__ A subtitle will only be shown if a title is also present." ], "name": "subtitle", "type": "AgChartSubtitleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the footnote shown at the bottom of the chart." ], "name": "footnote", "type": "AgChartFooterOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart highlighting." ], "name": "highlight", "type": "AgChartHighlightOptions", "optional": true }, { "kind": "member", "docs": [ "HTML overlays." ], "name": "overlays", "type": "AgChartOverlaysOptions", "optional": true }, { "kind": "member", "docs": [ "Global configuration that applies to all tooltips in the chart." ], "name": "tooltip", "type": "AgChartTooltipOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the chart legend." ], "name": "legend", "type": "AgChartLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the gradient legend." ], "name": "gradientLegend", "type": "AgGradientLegendOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for chart animations." ], "name": "animation", "type": "AgAnimationOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for asynchronously loaded data." ], "name": "dataSource", "type": { "kind": "typeRef", "type": "AgDataSourceOptions", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the context menu." ], "name": "contextMenu", "type": "AgContextMenuOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for localisation." ], "name": "locale", "type": "AgLocaleOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the ranges buttons." ], "name": "ranges", "type": "AgRangesOptions", "optional": true }, { "kind": "member", "docs": [ "Keyboard navigation options." ], "name": "keyboard", "type": "AgKeyboardOptions", "optional": true }, { "kind": "member", "docs": [ "Touch input options." ], "name": "touch", "type": "AgTouchOptions", "optional": true }, { "kind": "member", "docs": [ "Suppress treatment of series keys as JavaScript paths when `true`." ], "name": "suppressFieldDotNotation", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgBaseChartListeners", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the Navigator." ], "name": "navigator", "type": "AgNavigatorOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for synchronizing multiple charts." ], "name": "sync", "type": "AgChartSyncOptions", "optional": true }, { "kind": "member", "docs": [ "Configuration for the zoom options." ], "name": "zoom", "type": "AgZoomOptions", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "AgWaterfallSeriesThemeableOptions": { "kind": "interface", "name": "AgWaterfallSeriesThemeableOptions", "members": [ { "kind": "member", "docs": [ "Bar rendering direction.", "", "__Note:__ This option affects the layout direction of X and Y data values." ], "name": "direction", "type": { "kind": "union", "type": [ "'horizontal'", "'vertical'" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration used for the waterfall series item types." ], "name": "item", "type": { "kind": "typeRef", "type": "AgWaterfallSeriesItem", "typeArguments": [ "TDatum" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the connector lines." ], "name": "line", "type": "AgWaterfallSeriesLineOptions", "optional": true }, { "kind": "member", "docs": [ "Series-specific tooltip configuration." ], "name": "tooltip", "type": { "kind": "typeRef", "type": "AgSeriesTooltip", "typeArguments": [ "AgWaterfallSeriesTooltipRendererParams" ] }, "optional": true }, { "kind": "member", "docs": [ "Configuration for the waterfall series items when they are hovered over." ], "name": "highlightStyle", "type": "AgSeriesHighlightStyle", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the Mini Chart." ], "name": "showInMiniChart", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value." ], "name": "id", "type": "string", "optional": true, "defaultValue": "auto-generated value" }, { "kind": "member", "docs": [ "The data to use when rendering the series. If this is not supplied, data must be set on the chart instead." ], "name": "data", "type": { "kind": "array", "type": "TDatum" }, "optional": true }, { "kind": "member", "docs": [ "Whether to display the series." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The cursor to use for hovered markers. This config is identical to the CSS `cursor` property." ], "name": "cursor", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Range from a node that a click triggers the listener." ], "name": "nodeClickRange", "type": "InteractionRange", "optional": true }, { "kind": "member", "docs": [ "Whether to include the series in the legend." ], "name": "showInLegend", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "A map of event names to event listeners." ], "name": "listeners", "type": { "kind": "typeRef", "type": "AgSeriesListeners", "typeArguments": [ "TDatum" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "any" } }, "AgWaterfallSeriesTooltipRendererParams": { "kind": "interface", "name": "AgWaterfallSeriesTooltipRendererParams", "members": [ { "kind": "member", "docs": [ "The Id to distinguish the type of datum. This can be `positive`, `negative`, `total` or `subtotal`." ], "name": "itemId", "type": "AgWaterfallSeriesItemType", "optional": false }, { "kind": "member", "docs": [ "xKey as specified on series options." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "yKey as specified on series options." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "xName as specified on series options." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "yName as specified on series options." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Series title or yName depending on series configuration." ], "name": "title", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Apply rounded corners to each bar." ], "name": "cornerRadius", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": "any" } ], "genericsMap": { "TDatum": "TDatum" } }, "AgZoomAnchorPoint": { "kind": "typeAlias", "name": "AgZoomAnchorPoint", "type": { "kind": "union", "type": [ "'pointer'", "'start'", "'middle'", "'end'" ] } }, "AgZoomAutoScaling": { "kind": "interface", "name": "AgZoomAutoScaling", "members": [ { "kind": "member", "docs": [ "Set to `true` to enable the auto scaling of the y axis when zooming." ], "name": "enabled", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Padding to apply between the zoomed data and the boundary of the series." ], "name": "padding", "type": "Ratio", "optional": true } ] }, "AgZoomAxes": { "kind": "typeAlias", "name": "AgZoomAxes", "type": { "kind": "union", "type": [ "'x'", "'y'", "'xy'" ] } }, "AgZoomButton": { "kind": "interface", "name": "AgZoomButton", "members": [ { "kind": "member", "name": "value", "type": "AgZoomButtonValue", "optional": false }, { "kind": "member", "name": "section", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Icon to display on the button." ], "name": "icon", "type": "AgIconName", "optional": true }, { "kind": "member", "docs": [ "Text label to display on the button." ], "name": "label", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Text label to announce in screen readers." ], "name": "ariaLabel", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Tooltip text to display on hover over the button." ], "name": "tooltip", "type": "string", "optional": true } ] }, "AgZoomButtonValue": { "kind": "typeAlias", "name": "AgZoomButtonValue", "type": { "kind": "union", "type": [ "'reset'", "'zoom-in'", "'zoom-out'", "'pan-left'", "'pan-right'", "'pan-start'", "'pan-end'" ] } }, "AgZoomButtons": { "kind": "interface", "name": "AgZoomButtons", "members": [ { "kind": "member", "docs": [ "The buttons to show." ], "name": "buttons", "type": { "kind": "array", "type": "AgZoomButton" }, "optional": true }, { "kind": "member", "docs": [ "When the buttons should be visible." ], "name": "visible", "type": "AgZoomButtonsVisible", "optional": true, "defaultValue": "'hover'" }, { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ] }, "AgZoomButtonsVisible": { "kind": "typeAlias", "name": "AgZoomButtonsVisible", "type": { "kind": "union", "type": [ "'always'", "'zoomed'", "'hover'" ] } }, "AgZoomDeceleration": { "kind": "typeAlias", "name": "AgZoomDeceleration", "type": { "kind": "union", "type": [ "'off'", "'short'", "'long'", "Ratio" ] } }, "AgZoomEvent": { "kind": "interface", "name": "AgZoomEvent", "members": [ { "kind": "member", "name": "type", "type": "'zoom'", "optional": false }, { "kind": "member", "name": "ratioX", "type": "AgZoomEventRatio", "optional": false }, { "kind": "member", "name": "ratioY", "type": "AgZoomEventRatio", "optional": false }, { "kind": "member", "name": "rangeX", "type": "AgZoomEventRange", "optional": true }, { "kind": "member", "name": "rangeY", "type": "AgZoomEventRange", "optional": true }, { "kind": "member", "name": "autoScaledAxes", "type": "AgAutoScaledAxes", "optional": true } ] }, "AgZoomEventRange": { "kind": "interface", "name": "AgZoomEventRange", "members": [ { "kind": "member", "name": "start", "type": { "kind": "union", "type": [ "Date", "number" ] }, "optional": true }, { "kind": "member", "name": "end", "type": { "kind": "union", "type": [ "Date", "number" ] }, "optional": true } ] }, "AgZoomEventRatio": { "kind": "interface", "name": "AgZoomEventRatio", "members": [ { "kind": "member", "name": "start", "type": "Ratio", "optional": false }, { "kind": "member", "name": "end", "type": "Ratio", "optional": false } ] }, "AgZoomOptions": { "kind": "interface", "name": "AgZoomOptions", "members": [ { "kind": "member", "docs": [ "The anchor point for the x-axis about which to zoom into when scrolling." ], "name": "anchorPointX", "type": "AgZoomAnchorPoint", "optional": true, "defaultValue": "end" }, { "kind": "member", "docs": [ "The anchor point for the y-axis about which to zoom into when scrolling." ], "name": "anchorPointY", "type": "AgZoomAnchorPoint", "optional": true, "defaultValue": "middle" }, { "kind": "member", "docs": [ "The axes on which to zoom when scrolling, one of `xy`, `x`, or `y`." ], "name": "axes", "type": "AgZoomAxes", "optional": true, "defaultValue": "x" }, { "kind": "member", "docs": [ "A set of buttons to perform common zoom actions." ], "name": "buttons", "type": "AgZoomButtons", "optional": true }, { "kind": "member", "docs": [ "Rate of deceleration of panning when dragging and releasing a zoomed chart." ], "name": "deceleration", "type": "AgZoomDeceleration", "optional": true, "defaultValue": "short" }, { "kind": "member", "docs": [ "Set to `true` to enable the zoom module." ], "name": "enabled", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Set to `true` to enable dragging an axis to zoom series attached to that axis." ], "name": "enableAxisDragging", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Set to `true` to enable double-clicking to reset the chart to fully zoomed out." ], "name": "enableDoubleClickToReset", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Set to `true` to enable panning while zoomed." ], "name": "enablePanning", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Set to `true` to enable zooming with the mouse wheel." ], "name": "enableScrolling", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Set to `true` to enable selecting an area of the chart to zoom into." ], "name": "enableSelecting", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Set to `true` to enable zoom-panning with two touch points." ], "name": "enableTwoFingerZoom", "type": "boolean", "optional": true, "defaultValue": "true" }, { "kind": "member", "docs": [ "Set to `true` to keep the selection area matching the chart's aspect ratio." ], "name": "keepAspectRatio", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "The minimum number of items to be shown, beyond which zooming is stopped. Set to `0` to allow unlimited zooming." ], "name": "minVisibleItems", "type": "number", "optional": true, "defaultValue": "2" }, { "kind": "member", "docs": [ "The key that should be pressed to allow dragging to pan around while zoomed, one of `alt`, `ctrl`, `meta` or `shift`." ], "name": "panKey", "type": "AgZoomPanKey", "optional": true, "defaultValue": "alt" }, { "kind": "member", "docs": [ "The amount to zoom when scrolling with the mouse wheel, as a ratio of the full chart." ], "name": "scrollingStep", "type": "Ratio", "optional": true, "defaultValue": "0.1" }, { "kind": "member", "docs": [ "Zoom auto scaling options." ], "name": "autoScaling", "type": "AgZoomAutoScaling", "optional": true } ] }, "AgZoomPanKey": { "kind": "typeAlias", "name": "AgZoomPanKey", "type": { "kind": "union", "type": [ "'alt'", "'ctrl'", "'meta'", "'shift'" ] } }, "AgZoomRange": { "kind": "interface", "name": "AgZoomRange", "members": [ { "kind": "member", "docs": [ "The start of the axis zoom range." ], "name": "start", "type": { "kind": "union", "type": [ "Date", "number" ] }, "optional": true }, { "kind": "member", "docs": [ "The end of the axis zoom range." ], "name": "end", "type": { "kind": "union", "type": [ "Date", "number" ] }, "optional": true } ] }, "AgZoomRatio": { "kind": "interface", "name": "AgZoomRatio", "members": [ { "kind": "member", "docs": [ "The minimum value of the axis zoom ratio. Default: `0`" ], "name": "start", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "The maximum value of the axis zoom ratio. Default: `1`" ], "name": "end", "type": "Ratio", "optional": true } ] }, "AnnotationLinePoints": { "kind": "interface", "name": "AnnotationLinePoints", "members": [ { "kind": "member", "docs": [ "The starting point of a linear annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of a linear annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false } ] }, "Arc": { "kind": "typeAlias", "name": "Arc", "type": "any" }, "AxisOptions": { "kind": "interface", "name": "AxisOptions", "members": [ { "kind": "member", "docs": [ "The key used to retrieve x-values (categories) from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key used to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "A descriptive label for x-values." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A descriptive label for y-values." ], "name": "yName", "type": "string", "optional": true } ], "docs": [ "Represents configuration options for X and Y axes in a chart." ], "genericsMap": { "TDatum": "TDatum" } }, "AxisValue": { "kind": "typeAlias", "name": "AxisValue", "type": "any", "docs": [ "Alias to denote that a value is an axis value." ] }, "BBox": { "kind": "typeAlias", "name": "BBox", "type": "any" }, "BoxPlotOptionsKeys": { "kind": "interface", "name": "BoxPlotOptionsKeys", "members": [ { "kind": "member", "docs": [ "The key used to retrieve x-values (categories) from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve minimum values from the data." ], "name": "minKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve lower quartile values from the data." ], "name": "q1Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve median values from the data." ], "name": "medianKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve upper quartile values from the data." ], "name": "q3Key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve maximum values from the data." ], "name": "maxKey", "type": "string", "optional": false } ], "genericsMap": { "TDatum": "any" } }, "BoxPlotOptionsNames": { "kind": "interface", "name": "BoxPlotOptionsNames", "members": [ { "kind": "member", "docs": [ "A descriptive label for x-values." ], "name": "xName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A descriptive label for y-values." ], "name": "yName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of minimum values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "minName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of lower quartile values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "q1Name", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of median values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "medianName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of upper quartile values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "q3Name", "type": "string", "optional": true }, { "kind": "member", "docs": [ "A human-readable description of maximum values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters." ], "name": "maxName", "type": "string", "optional": true } ], "genericsMap": { "TDatum": "any" } }, "BubbleSeriesItemStylerParams": { "name": "BubbleSeriesItemStylerParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve size values from the data, used to control the size of the markers." ], "name": "sizeKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": false }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": false }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": false }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": false }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": false }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve values from the data to use as labels for the markers." ], "name": "labelKey", "type": "string", "optional": true } ] }, "Caption": { "kind": "typeAlias", "name": "Caption", "type": "AgChartCaptionOptions" }, "CategoryScale": { "kind": "typeAlias", "name": "CategoryScale", "type": "any" }, "ColorOperation": { "kind": "typeAlias", "name": "ColorOperation", "type": { "kind": "union", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$mix", "type": { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "string" ] }, { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "string" ] }, { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] } ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$foregroundBackgroundMix", "type": { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] } ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$foregroundBackgroundAccentMix", "type": { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] }, { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] } ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$interpolate", "type": { "kind": "tuple", "type": [ "Leaf", { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] } ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$isGradient", "type": { "kind": "tuple", "type": [ "Leaf" ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$isPattern", "type": { "kind": "tuple", "type": [ "Leaf" ] }, "optional": false } ] } ] } }, "CommonIgnoredProperties": { "kind": "typeAlias", "name": "CommonIgnoredProperties", "type": { "kind": "union", "type": [ "'cursor'", "'highlightStyle'", "'listeners'", "'nodeClickRange'", "'showInLegend'", "'showInMiniChart'", "'tooltip'", "'visible'", "'xName'", "'yName'" ] } }, "CssColor": { "kind": "typeAlias", "name": "CssColor", "type": "string", "docs": [ "Alias to denote that a value should be a CSS-compliant color string, such as `#FFFFFF` or `rgb(255, 255, 255)` or `white`." ] }, "DatumCallbackParams": { "kind": "interface", "name": "DatumCallbackParams", "members": [ { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "ItemType": "AgOhlcSeriesItemType" } }, "DatumItemCallbackParams": { "kind": "interface", "name": "DatumItemCallbackParams", "members": [ { "kind": "member", "docs": [ "The unique identifier of the item." ], "name": "itemId", "type": "ItemType", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false } ], "typeParams": [ { "kind": "typeParam", "name": "ItemType", "constraint": "string", "default": null }, { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "genericsMap": { "ItemType": "AgOhlcSeriesItemType" } }, "DeepPartial": { "kind": "typeAlias", "name": "DeepPartial", "type": "T extends Array ? T : T extends object ? { [K in keyof T]?: DeepPartial; } : T", "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": null, "default": null } ] }, "Degree": { "kind": "typeAlias", "name": "Degree", "type": "number", "docs": [ "Alias to denote that a value is an angle in degrees" ] }, "Direction": { "kind": "typeAlias", "name": "Direction", "type": { "kind": "union", "type": [ "'vertical'", "'horizontal'" ] } }, "DownloadOptions": { "kind": "interface", "name": "DownloadOptions", "members": [ { "kind": "member", "docs": [ "Name of downloaded image file. Defaults to `image`." ], "name": "fileName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Width of downloaded chart image in pixels. Defaults to current chart width." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Height of downloaded chart image in pixels. Defaults to current chart height." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A MIME-type string indicating the image format. The default format type is `image/png`. Options: `image/png`, `image/jpeg`." ], "name": "fileFormat", "type": "string", "optional": true } ] }, "DurationMs": { "kind": "typeAlias", "name": "DurationMs", "type": "number", "docs": [ "Alias to denote that a value is a duration in milliseconds" ] }, "ErrorBarCapOptions": { "kind": "interface", "name": "ErrorBarCapOptions", "members": [ { "kind": "member", "docs": [ "Absolute length of caps in pixels." ], "name": "length", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Length of caps relative to the shape used by the series." ], "name": "lengthRatio", "type": "Ratio", "optional": true }, { "kind": "member", "docs": [ "Whether to display the error bars." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "ErrorBarFormatterOption": { "kind": "interface", "name": "ErrorBarFormatterOption", "members": [ { "kind": "member", "docs": [ "Function used to return formatting for individual error bars, based on the given parameters. If the current error bar is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "typeRef", "type": "AgErrorBarItemStylerParams", "typeArguments": [ "TDatum" ] }, "AgErrorBarThemeableOptions" ] }, "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ] }, "ErrorBarKeyOptions": { "kind": "interface", "name": "ErrorBarKeyOptions", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the x-axis data." ], "name": "xLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the x-axis data." ], "name": "xUpperKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve lower bound error values from the y-axis data." ], "name": "yLowerKey", "type": "string", "optional": true }, { "kind": "member", "docs": [ "The key to use to retrieve upper bound error values from the y-axis data." ], "name": "yUpperKey", "type": "string", "optional": true } ] }, "ErrorBarNameOptions": { "kind": "interface", "name": "ErrorBarNameOptions", "members": [ { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the x-axis. This is the value to use in tooltips or labels." ], "name": "xLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the x-axis. This is the value to use in tooltips or labels." ], "name": "xUpperName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the lower bound error value for the y-axis. This is the value to use in tooltips or labels." ], "name": "yLowerName", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Human-readable description of the upper bound error value for the y-axis. This is the value to use in tooltips or labels." ], "name": "yUpperName", "type": "string", "optional": true } ] }, "ErrorBarStylingOptions": { "kind": "interface", "name": "ErrorBarStylingOptions", "members": [ { "kind": "member", "docs": [ "Whether to display the error bars." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "ExcludeLeaves": { "kind": "typeAlias", "name": "ExcludeLeaves", "type": { "kind": "union", "type": [ "string", "symbol", "number", "undefined", "AgGradientColor", "AgPatternColor" ] } }, "ExtendLiteralLeaves": { "kind": "typeAlias", "name": "ExtendLiteralLeaves", "type": "{ [P in keyof T]: NonNullable extends Array ? U extends E ? Array | Array | V : ExtendLiteralLeavesInner : ExtendLiteralLeavesInner; }", "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": null, "default": null }, { "kind": "typeParam", "name": "V", "constraint": null, "default": null }, { "kind": "typeParam", "name": "E", "constraint": null, "default": null } ], "docs": [ "Modify a type T by extending it's leaves with the type V, excluding any leaf that extends E.", "", "@param T type to extend", "@param V value to union with the leaves", "@param E leaf types to exclude and keep their original type" ], "genericsMap": { "V": "Operation", "E": "ExcludeLeaves" } }, "ExtendLiteralLeavesInner": { "kind": "typeAlias", "name": "ExtendLiteralLeavesInner", "type": "NonNullable extends Array ? Array> | V : T[P] extends E ? T[P] | V : ExtendLiteralLeaves", "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": null, "default": null }, { "kind": "typeParam", "name": "V", "constraint": null, "default": null }, { "kind": "typeParam", "name": "E", "constraint": null, "default": null }, { "kind": "typeParam", "name": "P", "constraint": "keyof T", "default": null } ] }, "Extendable": { "kind": "interface", "name": "Extendable", "members": [ { "kind": "member", "docs": [ "Whether the annotation should be extended away from the start." ], "name": "extendStart", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the annotation should be extended away from the end." ], "name": "extendEnd", "type": "boolean", "optional": true, "defaultValue": "false" } ] }, "FillOptions": { "kind": "interface", "name": "FillOptions", "members": [ { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true } ], "docs": [ "Represents options for filling shapes in a chart." ], "genericsMap": { "TDatum": "unknown" } }, "FillsOptions": { "kind": "interface", "name": "FillsOptions", "members": [ { "kind": "member", "docs": [ "Configuration for two or more colours, and the values they are rendered at." ], "name": "fills", "type": { "kind": "array", "type": "AgGaugeColorStop" }, "optional": true }, { "kind": "member", "docs": [ "Configuration the fills should be rendered." ], "name": "fillMode", "type": "AgGaugeFillMode", "optional": true, "defaultValue": "continuous" } ] }, "FontFamily": { "kind": "typeAlias", "name": "FontFamily", "type": "string" }, "FontOperation": { "name": "FontOperation", "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$rem", "type": { "kind": "union", "type": [ { "kind": "tuple", "type": [ "Leaf" ] }, { "kind": "tuple", "type": [ "Leaf", "Leaf" ] } ] }, "optional": false } ] }, "FontOptions": { "kind": "interface", "name": "FontOptions", "members": [ { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "docs": [ "Represents font styling options for text elements in a chart." ], "genericsMap": { "TParams": { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } } }, "FontSize": { "kind": "typeAlias", "name": "FontSize", "type": "number" }, "FontStyle": { "kind": "typeAlias", "name": "FontStyle", "type": { "kind": "union", "type": [ "'normal'", "'italic'", "'oblique'" ] } }, "FontWeight": { "kind": "typeAlias", "name": "FontWeight", "type": { "kind": "union", "type": [ "'normal'", "'bold'", "'bolder'", "'lighter'", "number" ] } }, "FormattableLabel": { "kind": "interface", "name": "FormattableLabel", "members": [ { "kind": "member", "docs": [ "Format string used when rendering labels." ], "name": "format", "type": "string", "optional": true } ] }, "Formatter": { "kind": "typeAlias", "name": "Formatter", "type": { "kind": "function", "params": [ { "kind": "param", "name": "params", "type": "P" } ], "returnType": { "kind": "union", "type": [ "string", "undefined" ] } }, "typeParams": [ { "kind": "typeParam", "name": "P", "constraint": null, "default": null } ] }, "GaugeDatum": { "kind": "interface", "name": "GaugeDatum", "members": [ { "kind": "member", "name": "value", "type": "number", "optional": false }, { "kind": "member", "name": "segmentStart", "type": "number", "optional": false }, { "kind": "member", "name": "segmentEnd", "type": "number", "optional": false } ] }, "GeoJSON": { "kind": "typeAlias", "name": "GeoJSON", "type": "any" }, "Group": { "kind": "typeAlias", "name": "Group", "type": "any" }, "IChartTheme": { "kind": "interface", "name": "IChartTheme", "members": [ { "kind": "member", "name": "palette", "type": { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "Required", "typeArguments": [ "AgChartThemePalette" ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "altUp", "type": "AgPaletteColors", "optional": false }, { "kind": "member", "name": "altDown", "type": "AgPaletteColors", "optional": false }, { "kind": "member", "name": "altNeutral", "type": "AgPaletteColors", "optional": false } ] } ] }, "optional": false }, { "kind": "member", "name": "getTemplateParameters", "type": { "kind": "function", "params": [], "returnType": { "kind": "typeRef", "type": "Map", "typeArguments": [ "symbol", "any" ] } }, "optional": false } ] }, "IColor": { "kind": "interface", "name": "IColor", "members": [ { "kind": "member", "name": "r", "type": "number", "optional": false }, { "kind": "member", "name": "g", "type": "number", "optional": false }, { "kind": "member", "name": "b", "type": "number", "optional": false }, { "kind": "member", "name": "a", "type": "number", "optional": false }, { "kind": "member", "name": "toHexString", "type": { "kind": "function", "params": [], "returnType": "string" }, "optional": false }, { "kind": "member", "name": "toHSB", "type": { "kind": "function", "params": [], "returnType": { "kind": "tuple", "type": [ "number", "number", "number" ] } }, "optional": false }, { "kind": "member", "name": "toRgbaString", "type": { "kind": "function", "params": [ { "kind": "param", "name": "fractionDigits", "type": "number" } ], "returnType": "string" }, "optional": false }, { "kind": "member", "name": "toString", "type": { "kind": "function", "params": [], "returnType": "string" }, "optional": false } ] }, "ISeriesMarker": { "kind": "interface", "name": "ISeriesMarker", "members": [ { "kind": "member", "name": "getStyle", "type": { "kind": "function", "params": [], "returnType": "AgSeriesMarkerStyle" }, "optional": false }, { "kind": "member", "docs": [ "Whether to show markers." ], "name": "enabled", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "Function used to return formatting for individual markers, based on the supplied information. If the current marker is highlighted, the `highlighted` property will be set to `true`; make sure to check this if you want to differentiate between the highlighted and un-highlighted states." ], "name": "itemStyler", "type": { "kind": "typeRef", "type": "Styler", "typeArguments": [ { "kind": "intersection", "type": [ { "kind": "typeRef", "type": "AgSeriesMarkerStylerParams", "typeArguments": [ "TDatum" ] }, "TParams" ] }, "AgSeriesMarkerStyle" ] }, "optional": true }, { "kind": "member", "docs": [ "The size in pixels of the markers." ], "name": "size", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The shape to use for the markers. You can also supply a custom marker by providing a `AgMarkerShapeFn` function." ], "name": "shape", "type": "AgMarkerShape", "optional": true }, { "kind": "member", "docs": [ "The colour for filling shapes." ], "name": "fill", "type": "AgColorType", "optional": true }, { "kind": "member", "docs": [ "The opacity of the fill colour." ], "name": "fillOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "TParams", "constraint": null, "default": null } ], "genericsMap": { "TDatum": "unknown" } }, "IgnoredMiniChartSeries": { "kind": "typeAlias", "name": "IgnoredMiniChartSeries", "type": { "kind": "union", "type": [ "'funnel'", "'cone-funnel'" ] } }, "ImageDataUrlOptions": { "kind": "interface", "name": "ImageDataUrlOptions", "members": [ { "kind": "member", "docs": [ "Width of downloaded chart image in pixels. Defaults to current chart width." ], "name": "width", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "Height of downloaded chart image in pixels. Defaults to current chart height." ], "name": "height", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "A MIME-type string indicating the image format. The default format type is `image/png`. Options: `image/png`, `image/jpeg`." ], "name": "fileFormat", "type": "string", "optional": true } ] }, "IntegratedModule": { "kind": "interface", "name": "IntegratedModule", "members": [ { "kind": "member", "name": "VERSION", "type": "string", "optional": false }, { "kind": "member", "name": "_Scene", "type": "_IScene", "optional": false }, { "kind": "member", "name": "_Theme", "type": "_ITheme", "optional": false }, { "kind": "member", "name": "_Util", "type": "_IUtil", "optional": false }, { "kind": "member", "name": "create", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "AgChartInstanceOptions" } ], "returnType": { "kind": "typeRef", "type": "AgChartInstance", "typeArguments": [ "AgChartInstanceOptions" ] } }, "optional": false }, { "kind": "member", "name": "createSparkline", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "AgSparklineOptions" } ], "returnType": { "kind": "typeRef", "type": "AgChartInstance", "typeArguments": [ "AgSparklineOptions" ] } }, "optional": false }, { "kind": "member", "name": "setup", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false }, { "kind": "member", "name": "isEnterprise", "type": "boolean", "optional": false }, { "kind": "member", "name": "setGridContext", "type": { "kind": "function", "params": [ { "kind": "param", "name": "gridContext", "type": "boolean" } ], "returnType": "void" }, "optional": true }, { "kind": "member", "name": "setLicenseKey", "type": { "kind": "function", "params": [ { "kind": "param", "name": "licenseKey", "type": "string" } ], "returnType": "void" }, "optional": true } ] }, "InteractionRange": { "kind": "typeAlias", "name": "InteractionRange", "type": { "kind": "union", "type": [ "PixelSize", "'exact'", "'nearest'" ] }, "docs": [ "Define a range within which an interaction can trigger on a point with one of: A distance in pixels from a point within which the event can be triggered.", "- `'exact'` triggers when the event occurs directly over a point.", "- `'nearest'` always tracks the nearest point anywhere on the chart." ] }, "LabelOptions": { "kind": "interface", "name": "LabelOptions", "members": [ { "kind": "member", "docs": [ "A custom formatting function used to convert values into text for display by labels." ], "name": "formatter", "type": { "kind": "typeRef", "type": "Formatter", "typeArguments": [ "T" ] }, "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ], "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": null, "default": null } ], "genericsMap": { "T": "AgAnnotationLabelFormatterParams" } }, "LabelPlacement": { "kind": "typeAlias", "name": "LabelPlacement", "type": { "kind": "union", "type": [ "'top'", "'bottom'", "'left'", "'right'" ] } }, "Leaf": { "kind": "typeAlias", "name": "Leaf", "type": { "kind": "union", "type": [ "Operation", "T" ] }, "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": null, "default": "ExcludeLeaves" } ], "genericsMap": { "T": "ExcludeLeaves" } }, "Line": { "kind": "typeAlias", "name": "Line", "type": "any" }, "LineDashOptions": { "kind": "interface", "name": "LineDashOptions", "members": [ { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ], "docs": [ "Represents options for defining dashed strokes in a chart." ], "genericsMap": { "TDatum": "unknown" } }, "LineOptions": { "kind": "interface", "name": "LineOptions", "members": [ { "kind": "member", "docs": [ "Defines how the line stroke is rendered. If `lineDash` is configured, this takes priority over the `lineStyle` property." ], "name": "lineStyle", "type": "AgAnnotationLineStyleType", "optional": true }, { "kind": "member", "docs": [ "An array specifying the length in pixels of alternating dashes and gaps." ], "name": "lineDash", "type": { "kind": "array", "type": "PixelSize" }, "optional": true }, { "kind": "member", "docs": [ "The initial offset of the dashed line in pixels." ], "name": "lineDashOffset", "type": "PixelSize", "optional": true } ] }, "LinearScale": { "kind": "typeAlias", "name": "LinearScale", "type": "any" }, "Listener": { "kind": "typeAlias", "name": "Listener", "type": { "kind": "function", "params": [ { "kind": "param", "name": "event", "type": "E" } ], "returnType": "void" }, "typeParams": [ { "kind": "typeParam", "name": "E", "constraint": null, "default": null } ] }, "Lockable": { "kind": "interface", "name": "Lockable", "members": [ { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" } ] }, "LogicOperation": { "kind": "typeAlias", "name": "LogicOperation", "type": { "kind": "union", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$if", "type": { "kind": "tuple", "type": [ "Leaf", "Leaf", "Leaf" ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$or", "type": { "kind": "array", "type": "Leaf" }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$and", "type": { "kind": "array", "type": "Leaf" }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$eq", "type": { "kind": "tuple", "type": [ "Leaf", "Leaf" ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$not", "type": { "kind": "tuple", "type": [ "Leaf" ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$switch", "type": { "kind": "tuple", "type": [ "Leaf" ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$isOperation", "type": "string", "optional": false } ] } ] } }, "Marker": { "kind": "typeAlias", "name": "Marker", "type": "any" }, "MessageFormatterParams": { "kind": "interface", "name": "MessageFormatterParams", "members": [ { "kind": "member", "docs": [ "Key of the translation - usually defined in `localeText`." ], "name": "key", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The default, unformatted translation, if it exists in `localeText`." ], "name": "defaultValue", "type": { "kind": "union", "type": [ "string", "undefined" ] }, "optional": false }, { "kind": "member", "docs": [ "Variables used for the translation. Keyed by the name of the variables. Values can be string, numbers, or dates." ], "name": "variables", "type": { "kind": "typeRef", "type": "Record", "typeArguments": [ "string", "any" ] }, "optional": false } ] }, "NumericOperation": { "kind": "typeAlias", "name": "NumericOperation", "type": { "kind": "union", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$even", "type": { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] } ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$mul", "type": { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] }, { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] } ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$round", "type": { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "number" ] } ] }, "optional": false } ] } ] } }, "OhlcItemCallbackParams": { "name": "OhlcItemCallbackParams", "typeParams": [ { "kind": "typeParam", "name": "TDatum", "constraint": null, "default": null } ], "kind": "interface", "members": [ { "kind": "member", "docs": [ "The unique identifier of the item." ], "name": "itemId", "type": "ItemType", "optional": false }, { "kind": "member", "docs": [ "The data point associated with the label." ], "name": "datum", "type": "TDatum", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Indicates whether the element is highlighted." ], "name": "highlighted", "type": "boolean", "optional": false } ], "genericsMap": { "ItemType": "AgOhlcSeriesItemType" } }, "Opacity": { "kind": "typeAlias", "name": "Opacity", "type": "number", "docs": [ "Alias to denote that a value reflects an alpha opacity in the range [0, 1]." ] }, "Operation": { "kind": "typeAlias", "name": "Operation", "type": { "kind": "union", "type": [ "PathOperation", "LogicOperation", "NumericOperation", "TransformOperation", "FontOperation", "ColorOperation" ] } }, "OrientableLabel": { "kind": "interface", "name": "OrientableLabel", "members": [ { "kind": "member", "docs": [ "Label orientation.", "`fixed` - all labels remain in a fixed orientation of horizontal text.", "`parallel` - labels are in a circle around the axis.", "`perpendicular` - labels are in the radial direction perpendicular to the axis." ], "name": "orientation", "type": "AgAngleAxisLabelOrientation", "optional": true, "defaultValue": "fixed" } ] }, "OverflowStrategy": { "kind": "typeAlias", "name": "OverflowStrategy", "type": { "kind": "union", "type": [ "'ellipsis'", "'hide'" ] }, "docs": [ "Adjusts the behaviour of labels when they overflow", "- `'ellipsis'` will truncate the text to fit, appending an ellipsis (...)", "- `'hide'` only displays the label if it completely fits within its bounds, and removes it if it would overflow" ] }, "PaletteParam": { "kind": "typeAlias", "name": "PaletteParam", "type": { "kind": "union", "type": [ "'type'", "'fills'", "'fillsFallback'", "'fill'", "'fillFallback'", "'strokes'", "'stroke'", "'gradients'", "'gradient'", "'sequentialColors'", "'divergingColors'", "'hierarchyColors'", "'secondSequentialColors'", "'secondDivergingColors'", "'secondHierarchyColors'", "'range2'", "'up.fill'", "'up.stroke'", "'down.fill'", "'down.stroke'", "'altUp.fill'", "'altUp.stroke'", "'altDown.fill'", "'altDown.stroke'", "'neutral.fill'", "'neutral.stroke'" ] } }, "Path": { "kind": "typeAlias", "name": "Path", "type": "any" }, "PathOperation": { "kind": "typeAlias", "name": "PathOperation", "type": { "kind": "union", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$ref", "type": "ThemeParam", "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$palette", "type": "PaletteParam", "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$path", "type": { "kind": "union", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "string" ] }, { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "string" ] }, "Leaf" ] }, { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "string" ] }, "Leaf", "Leaf" ] } ] }, "optional": false } ] } ] } }, "PixelSize": { "kind": "typeAlias", "name": "PixelSize", "type": "number", "docs": [ "Alias to denote that a value is a measurement in pixels." ] }, "RadialColumnShape": { "kind": "typeAlias", "name": "RadialColumnShape", "type": "any" }, "Ratio": { "kind": "typeAlias", "name": "Ratio", "type": "number", "docs": [ "Alias to denote that a value is a ratio, usually in the range [0, 1]." ] }, "Rect": { "kind": "typeAlias", "name": "Rect", "type": "any" }, "Renderer": { "kind": "typeAlias", "name": "Renderer", "type": { "kind": "function", "params": [ { "kind": "param", "name": "params", "type": "P" } ], "returnType": { "kind": "union", "type": [ "string", "R" ] } }, "typeParams": [ { "kind": "typeParam", "name": "P", "constraint": null, "default": null }, { "kind": "typeParam", "name": "R", "constraint": null, "default": null } ] }, "Scene": { "kind": "typeAlias", "name": "Scene", "type": "any" }, "Sector": { "kind": "typeAlias", "name": "Sector", "type": "any" }, "SeriesCallbackParams": { "kind": "interface", "name": "SeriesCallbackParams", "members": [ { "kind": "member", "docs": [ "The data associated with the series." ], "name": "data", "type": "any", "optional": false }, { "kind": "member", "docs": [ "The unique identifier of the series." ], "name": "seriesId", "type": "string", "optional": false } ] }, "SeriesKeyOptions": { "kind": "interface", "name": "SeriesKeyOptions", "members": [ { "kind": "member", "docs": [ "The key to use to retrieve x-values from the data." ], "name": "xKey", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The key to use to retrieve y-values from the data." ], "name": "yKey", "type": "string", "optional": true } ] }, "Shape": { "kind": "typeAlias", "name": "Shape", "type": "any" }, "SizeParams": { "kind": "interface", "name": "SizeParams", "members": [ { "kind": "member", "name": "size", "type": "number", "optional": false } ], "genericsMap": { "TDatum": "TDatum" } }, "StrokeOptions": { "kind": "interface", "name": "StrokeOptions", "members": [ { "kind": "member", "docs": [ "The colour for the stroke." ], "name": "stroke", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The width of the stroke in pixels." ], "name": "strokeWidth", "type": "PixelSize", "optional": true }, { "kind": "member", "docs": [ "The opacity of the stroke colour." ], "name": "strokeOpacity", "type": "Opacity", "optional": true } ], "docs": [ "Represents options for the strokes in a chart." ], "genericsMap": { "TDatum": "unknown" } }, "Styler": { "kind": "typeAlias", "name": "Styler", "type": { "kind": "function", "params": [ { "kind": "param", "name": "params", "type": "P" } ], "returnType": { "kind": "union", "type": [ "S", "undefined" ] } }, "typeParams": [ { "kind": "typeParam", "name": "P", "constraint": null, "default": null }, { "kind": "typeParam", "name": "S", "constraint": null, "default": null } ] }, "TextAlign": { "kind": "typeAlias", "name": "TextAlign", "type": { "kind": "union", "type": [ "'left'", "'center'", "'right'" ] } }, "TextWrap": { "kind": "typeAlias", "name": "TextWrap", "type": { "kind": "union", "type": [ "'never'", "'always'", "'hyphenate'", "'on-space'" ] }, "docs": [ "Text wrapping strategy for labels.", "- `'always'` will always wrap text to fit within the tile.", "- `'hyphenate'` is similar to `'always'`, but inserts a hyphen (`-`) if forced to wrap in the middle of a word.", "- `'on-space'` will only wrap on white space. If there is no possibility to wrap a line on space and satisfy the tile dimensions, the text will be truncated.", "- `'never'` disables text wrapping.", " Default: `'on-space'`" ] }, "TextualAnnotation": { "kind": "interface", "name": "TextualAnnotation", "members": [ { "kind": "member", "docs": [ "The text content." ], "name": "text", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "TextualPointAnnotation": { "kind": "interface", "name": "TextualPointAnnotation", "members": [ { "kind": "member", "docs": [ "The text content." ], "name": "text", "type": "string", "optional": false }, { "kind": "member", "docs": [ "The x-value of the point." ], "name": "x", "type": "AgAnnotationValue", "optional": false }, { "kind": "member", "docs": [ "The y-value of the point." ], "name": "y", "type": "number", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "TextualStartEndAnnotation": { "kind": "interface", "name": "TextualStartEndAnnotation", "members": [ { "kind": "member", "docs": [ "The starting point of the annotation." ], "name": "start", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The end point of the annotation." ], "name": "end", "type": "AgAnnotationPoint", "optional": false }, { "kind": "member", "docs": [ "The text content." ], "name": "text", "type": "string", "optional": false }, { "kind": "member", "docs": [ "Configuration for the drag handle." ], "name": "handle", "type": "AgAnnotationHandle", "optional": true }, { "kind": "member", "docs": [ "Whether the annotation should be locked to prevent editing." ], "name": "locked", "type": "boolean", "optional": true, "defaultValue": "false" }, { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true }, { "kind": "member", "docs": [ "The colour for text elements." ], "name": "color", "type": "CssColor", "optional": true }, { "kind": "member", "docs": [ "The style to use for text elements." ], "name": "fontStyle", "type": "FontStyle", "optional": true }, { "kind": "member", "docs": [ "The font weight to use for text elements." ], "name": "fontWeight", "type": "FontWeight", "optional": true }, { "kind": "member", "docs": [ "The size of the font in pixels for text elements." ], "name": "fontSize", "type": "FontSize", "optional": true }, { "kind": "member", "docs": [ "The font family for text elements." ], "name": "fontFamily", "type": "FontFamily", "optional": true } ] }, "ThemeParam": { "kind": "typeAlias", "name": "ThemeParam", "type": "keyof AgChartThemeParams" }, "TimeInterval": { "kind": "interface", "name": "TimeInterval", "members": [ { "kind": "member", "docs": [ "Returns a new date representing the latest interval boundary date before or equal to date. For example, `day.floor(date)` typically returns 12:00 AM local time on the given date.", "@param date" ], "name": "floor", "type": { "kind": "function", "params": [ { "kind": "param", "name": "date", "type": { "kind": "union", "type": [ "Date", "number" ] } } ], "returnType": "Date" }, "optional": false }, { "kind": "member", "docs": [ "Returns a new date representing the earliest interval boundary date after or equal to date.", "@param date" ], "name": "ceil", "type": { "kind": "function", "params": [ { "kind": "param", "name": "date", "type": { "kind": "union", "type": [ "Date", "number" ] } } ], "returnType": "Date" }, "optional": false }, { "kind": "member", "docs": [ "Returns an array of dates representing every interval boundary after or equal to start (inclusive) and before stop (exclusive).", "@param start Range start.", "@param stop Range end.", "@param params If specified, the requested range will be extended to the closest \"nice\" values." ], "name": "range", "type": { "kind": "function", "params": [ { "kind": "param", "name": "start", "type": "Date" }, { "kind": "param", "name": "stop", "type": "Date" }, { "kind": "param", "name": "params", "type": { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "extend", "type": "boolean", "optional": true } ] } } ], "returnType": { "kind": "array", "type": "Date" } }, "optional": false } ] }, "Toggleable": { "kind": "interface", "name": "Toggleable", "members": [ { "kind": "member", "docs": [ "Determines whether the associated elements should be displayed on the chart." ], "name": "enabled", "type": "boolean", "optional": true } ], "docs": [ "Represents toggleable options for chart elements." ], "genericsMap": { "TParams": { "kind": "typeRef", "type": "AgTreemapSeriesLabelFormatterParams", "typeArguments": [ "TDatum" ] } } }, "ToolbarButton": { "kind": "interface", "name": "ToolbarButton", "members": [ { "kind": "member", "docs": [ "Icon to display on the button." ], "name": "icon", "type": "AgIconName", "optional": true }, { "kind": "member", "docs": [ "Text label to display on the button." ], "name": "label", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Text label to announce in screen readers." ], "name": "ariaLabel", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Tooltip text to display on hover over the button." ], "name": "tooltip", "type": "string", "optional": true } ] }, "ToolbarSwitch": { "kind": "interface", "name": "ToolbarSwitch", "members": [ { "kind": "member", "docs": [ "Overrides for the switch-button when checked." ], "name": "checkedOverrides", "type": "ToolbarButton", "optional": true }, { "kind": "member", "docs": [ "Icon to display on the button." ], "name": "icon", "type": "AgIconName", "optional": true }, { "kind": "member", "docs": [ "Text label to display on the button." ], "name": "label", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Text label to announce in screen readers." ], "name": "ariaLabel", "type": "string", "optional": true }, { "kind": "member", "docs": [ "Tooltip text to display on hover over the button." ], "name": "tooltip", "type": "string", "optional": true } ] }, "TransformOperation": { "kind": "typeAlias", "name": "TransformOperation", "type": { "kind": "union", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$map", "type": { "kind": "tuple", "type": [ "Leaf", "Leaf" ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$find", "type": { "kind": "tuple", "type": [ "Leaf", "Leaf" ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$merge", "type": { "kind": "array", "type": { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "object" ] } }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$omit", "type": { "kind": "tuple", "type": [ { "kind": "typeRef", "type": "Leaf", "typeArguments": [ { "kind": "array", "type": "string" } ] }, { "kind": "typeRef", "type": "Leaf", "typeArguments": [ "object" ] } ] }, "optional": false } ] }, { "kind": "typeLiteral", "members": [ { "kind": "member", "name": "$value", "type": { "kind": "union", "type": [ "'$1'", "'$index'" ] }, "optional": false } ] } ] } }, "TranslatableGroup": { "kind": "typeAlias", "name": "TranslatableGroup", "type": "any" }, "ValueType": { "kind": "typeAlias", "name": "ValueType", "type": { "kind": "union", "type": [ "string", "number", "AgStateSerializableDate" ] } }, "VerifyAgBaseChartThemeOverrides": { "name": "VerifyAgBaseChartThemeOverrides", "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": null, "default": "AgBaseChartOptions" } ], "kind": "interface", "members": [ { "kind": "member", "name": "common", "type": { "kind": "typeRef", "type": "Partial", "typeArguments": [ "T" ] }, "optional": true } ], "genericsMap": { "T": "AgBaseChartOptions" } }, "VerticalAlign": { "kind": "typeAlias", "name": "VerticalAlign", "type": { "kind": "union", "type": [ "'top'", "'middle'", "'bottom'" ] } }, "Visible": { "kind": "interface", "name": "Visible", "members": [ { "kind": "member", "docs": [ "Whether the element should be visible." ], "name": "visible", "type": "boolean", "optional": true } ] }, "WaterfallSeriesTotalMeta": { "kind": "interface", "name": "WaterfallSeriesTotalMeta", "members": [ { "kind": "member", "docs": [ "Configuration for the calculation of the value. This can be `total` or `subtotal`, `total` shows the cumulative value from `0` to the current data position, while `subtotal` shows the cumulative value from the previous subtotal value to the current position." ], "name": "totalType", "type": { "kind": "union", "type": [ "'subtotal'", "'total'" ] }, "optional": false }, { "kind": "member", "docs": [ "The index after which the total item will be displayed." ], "name": "index", "type": "number", "optional": false }, { "kind": "member", "docs": [ "The label to display at the axis position where the total value is positioned." ], "name": "axisLabel", "type": "string", "optional": false } ] }, "WithThemeParams": { "name": "WithThemeParams", "typeParams": [ { "kind": "typeParam", "name": "T", "constraint": null, "default": null } ], "kind": "interface", "members": [], "genericsMap": { "V": "Operation", "E": "ExcludeLeaves" } }, "_AgChartInstanceInterface": { "kind": "interface", "name": "_AgChartInstanceInterface", "members": [ { "kind": "member", "docs": [ "Update an existing `AgChartInstance`. Options provided should be complete and not partial.", "", "Returns a `Promise` that resolves once the requested change has been rendered.", "", "__NOTE:__ As each call could trigger a chart redraw, multiple calls in quick succession could result in undesirable flickering. Callers should batch up and/or debounce changes to avoid unintended partial update renderings." ], "name": "update", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "AgChartOptions" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Update an existing `AgChartInstance` by applying a partial set of option changes.", "", "Returns a `Promise` that resolves once the requested change has been rendered.", "", "__NOTE:__ As each call could trigger a chart redraw, each individual delta options update should leave the chart in a valid options state.", " Also, multiple calls in quick succession could result in undesirable flickering. Callers should batch up and/or debounce changes to avoid unintended partial update renderings." ], "name": "updateDelta", "type": { "kind": "function", "params": [ { "kind": "param", "name": "deltaOptions", "type": "AgChartOptions" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Get the `AgChartOptions` representing the current chart configuration." ], "name": "getOptions", "type": { "kind": "function", "params": [], "returnType": "AgChartOptions" }, "optional": false }, { "kind": "member", "docs": [ "Returns a `Promise` that resolves once any pending changes have been rendered." ], "name": "waitForUpdate", "type": { "kind": "function", "params": [], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Starts a browser-based image download for the given `AgChartInstance`.", "", "Returns a `Promise` that resolves once the download has been initiated." ], "name": "download", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "DownloadOptions" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Reset animation state; treat the next AgChartInstance.update() as-if the chart is being created from scratch." ], "name": "resetAnimations", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false }, { "kind": "member", "docs": [ "Skip animations on the next redraw." ], "name": "skipAnimations", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false }, { "kind": "member", "docs": [ "Returns a base64-encoded image data URL for the given `AgChartInstance`." ], "name": "getImageDataURL", "type": { "kind": "function", "params": [ { "kind": "param", "name": "options", "type": "ImageDataUrlOptions" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "string" ] } }, "optional": false }, { "kind": "member", "docs": [ "Returns a representation of the current state of the given `AgChartInstance`." ], "name": "getState", "type": { "kind": "function", "params": [], "returnType": "AgChartState" }, "optional": false }, { "kind": "member", "docs": [ "Sets the state of the given `AgChartInstance` to the state provided." ], "name": "setState", "type": { "kind": "function", "params": [ { "kind": "param", "name": "state", "type": "AgChartState" } ], "returnType": { "kind": "typeRef", "type": "Promise", "typeArguments": [ "void" ] } }, "optional": false }, { "kind": "member", "docs": [ "Destroy the chart instance and any allocated resources supporting its rendering." ], "name": "destroy", "type": { "kind": "function", "params": [], "returnType": "void" }, "optional": false } ], "genericsMap": { "O": "AgChartOptions" } }, "_IScene": { "kind": "interface", "name": "_IScene", "members": [ { "kind": "member", "name": "Path", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Path", "optional": false } ] }, "Path" ] }, "optional": false }, { "kind": "member", "name": "Group", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Group", "optional": false } ] }, "Group" ] }, "optional": false }, { "kind": "member", "name": "Scene", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (opts: { width: number; height: number; }): Scene", "optional": false } ] }, "Scene" ] }, "optional": false }, { "kind": "member", "name": "Rect", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Rect", "optional": false } ] }, "Rect" ] }, "optional": false }, { "kind": "member", "name": "BBox", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (x: number, y: number, w: number, h: number): BBox", "optional": false } ] }, "BBox" ] }, "optional": false }, { "kind": "member", "name": "Arc", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Arc", "optional": false } ] }, "Arc" ] }, "optional": false }, { "kind": "member", "name": "Line", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Line", "optional": false } ] }, "Line" ] }, "optional": false }, { "kind": "member", "name": "Sector", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Sector", "optional": false } ] }, "Sector" ] }, "optional": false }, { "kind": "member", "name": "Marker", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Marker", "optional": false } ] }, "Marker" ] }, "optional": false }, { "kind": "member", "name": "Shape", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Shape", "optional": false } ] }, "Shape" ] }, "optional": false }, { "kind": "member", "name": "TranslatableGroup", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): TranslatableGroup", "optional": false } ] }, "TranslatableGroup" ] }, "optional": false }, { "kind": "member", "name": "RadialColumnShape", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): RadialColumnShape", "optional": false } ] }, "RadialColumnShape" ] }, "optional": false }, { "kind": "member", "name": "Caption", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): Caption", "optional": false } ] }, "Caption" ] }, "optional": false }, { "kind": "member", "name": "CategoryScale", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): CategoryScale", "optional": false } ] }, "CategoryScale" ] }, "optional": false }, { "kind": "member", "name": "LinearScale", "type": { "kind": "intersection", "type": [ { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (): LinearScale", "optional": false } ] }, "LinearScale" ] }, "optional": false }, { "kind": "member", "name": "toRadians", "type": { "kind": "function", "params": [ { "kind": "param", "name": "degrees", "type": "number" } ], "returnType": "number" }, "optional": false }, { "kind": "member", "name": "getRadialColumnWidth", "type": { "kind": "function", "params": [ { "kind": "param", "name": "startAngle", "type": "number" }, { "kind": "param", "name": "endAngle", "type": "number" }, { "kind": "param", "name": "axisOuterRadius", "type": "number" }, { "kind": "param", "name": "columnWidthRatio", "type": "number" }, { "kind": "param", "name": "maxColumnWidthRatio", "type": "number" } ], "returnType": "number" }, "optional": false } ] }, "_ITheme": { "kind": "interface", "name": "_ITheme", "members": [ { "kind": "member", "name": "themeNames", "type": { "kind": "array", "type": "string" }, "optional": false }, { "kind": "member", "name": "themeSymbols", "type": { "kind": "typeRef", "type": "Record", "typeArguments": [ "string", { "kind": "union", "type": [ "symbol", "boolean", "string" ] } ] }, "optional": false }, { "kind": "member", "name": "getChartTheme", "type": { "kind": "function", "params": [ { "kind": "param", "name": "value", "type": "unknown" } ], "returnType": "IChartTheme" }, "optional": false }, { "kind": "member", "name": "resolveOperation", "type": { "kind": "function", "params": [ { "kind": "param", "name": "operation", "type": "Operation" } ], "returnType": "any" }, "optional": false }, { "kind": "member", "name": "themes", "type": { "kind": "typeRef", "type": "Record", "typeArguments": [ "string", { "kind": "function", "params": [], "returnType": "IChartTheme" } ] }, "optional": false } ] }, "_IUtil": { "kind": "interface", "name": "_IUtil", "members": [ { "kind": "member", "name": "Color", "type": { "kind": "typeLiteral", "members": [ { "kind": "member", "name": null, "type": "new (r: number, g: number, b: number, a?: number): IColor", "optional": false }, { "kind": "member", "name": "fromHSB", "type": { "kind": "function", "params": [ { "kind": "param", "name": "h", "type": "number" }, { "kind": "param", "name": "s", "type": "number" }, { "kind": "param", "name": "b", "type": "number" }, { "kind": "param", "name": "a", "type": "number" } ], "returnType": "IColor" }, "optional": false }, { "kind": "member", "name": "fromString", "type": { "kind": "function", "params": [ { "kind": "param", "name": "str", "type": "string" } ], "returnType": "IColor" }, "optional": false }, { "kind": "member", "name": "validColorString", "type": { "kind": "function", "params": [ { "kind": "param", "name": "str", "type": "string" } ], "returnType": "boolean" }, "optional": false } ] }, "optional": false }, { "kind": "member", "name": "interpolateColor", "type": { "kind": "function", "params": [ { "kind": "param", "name": "a", "type": { "kind": "union", "type": [ "IColor", "string" ] } }, { "kind": "param", "name": "b", "type": { "kind": "union", "type": [ "IColor", "string" ] } } ], "returnType": { "kind": "function", "params": [ { "kind": "param", "name": "delta", "type": "number" } ], "returnType": "string" } }, "optional": false } ] }, "AgChartAxisOptions": { "kind": "typeAlias", "name": "AgChartAxisOptions", "type": { "kind": "union", "type": [ "AgNumberAxisOptions", "AgLogAxisOptions", "AgCategoryAxisOptions", "AgOrdinalTimeAxisOptions", "AgGroupedCategoryAxisOptions", "AgTimeAxisOptions", "AgAngleCategoryAxisOptions", "AgAngleNumberAxisOptions", "AgRadiusCategoryAxisOptions", "AgRadiusNumberAxisOptions" ] } }, "AgChartSeriesOptions": { "kind": "typeAlias", "name": "AgChartSeriesOptions", "type": { "kind": "union", "type": [ "AgAreaSeriesOptions", "AgBarSeriesOptions", "AgBoxPlotSeriesOptions", "AgBubbleSeriesOptions", "AgCandlestickSeriesOptions", "AgConeFunnelSeriesOptions", "AgFunnelSeriesOptions", "AgHeatmapSeriesOptions", "AgHistogramSeriesOptions", "AgLineSeriesOptions", "AgOhlcSeriesOptions", "AgRangeAreaSeriesOptions", "AgRangeBarSeriesOptions", "AgScatterSeriesOptions", "AgWaterfallSeriesOptions", "AgDonutSeriesOptions", "AgPieSeriesOptions", "AgRadarLineSeriesOptions", "AgRadarAreaSeriesOptions", "AgRadialBarSeriesOptions", "AgRadialColumnSeriesOptions", "AgNightingaleSeriesOptions", "AgTreemapSeriesOptions", "AgSunburstSeriesOptions", "AgMapShapeSeriesOptions", "AgMapLineSeriesOptions", "AgMapMarkerSeriesOptions", "AgMapShapeBackgroundOptions", "AgMapLineBackgroundOptions", "AgSankeySeriesOptions", "AgChordSeriesOptions", "AgPyramidSeriesOptions" ] } } }