@grapecity/wijmo.chart 5.20261.52 → 5.20262.60

package/index.d.ts

@@ -1,6 +1,6 @@
 /*!
     *
-    * Wijmo Library 5.20261.52
+    * Wijmo Library 5.20262.60
     * https://developer.mescius.com/wijmo
     *
     * Copyright(c) MESCIUS inc. All rights reserved.
@@ -28,7 +28,7 @@
  *
  */
 export declare var ___keepComment: any;
-import { Point, Size, Rect, DataType, Event, EventArgs, ICollectionView, ObservableArray, Control, Tooltip, CancelEventArgs } from '@grapecity/wijmo';
+import { Point, Rect, Size, DataType, Event, EventArgs, ICollectionView, ObservableArray, Control, Tooltip, CancelEventArgs } from '@grapecity/wijmo';
 import * as selfModule from '@grapecity/wijmo.chart';
 export declare class _VolumeHelper {
     private _volumes;
@@ -72,53 +72,6 @@ export declare class _Spline {
         ys: any;
     };
 }
-export declare const AxisClsNames: {
-    axisX: string;
-    axisXLabels: string;
-    axisY: string;
-    axisYLabels: string;
-    gridline: string;
-    gridlineMinor: string;
-    line: string;
-    tick: string;
-    tickMinor: string;
-};
-export declare const DataLabelClsNames: {
-    border: string;
-    label: string;
-    labels: string;
-    line: string;
-};
-export declare const FlexChartClsNames: {
-    footer: string;
-    header: string;
-    hostElement: string;
-    label: string;
-    legend: string;
-    plotArea: string;
-    title: string;
-    touchDisabled: string;
-};
-export declare const FlexPieClsNames: {
-    hostElement: string;
-    slice: string;
-    sliceGroup: string;
-};
-export declare const LegendClsNames: {
-    legend: string;
-    title: string;
-};
-export declare const LineMarkerClsNames: {
-    container: string;
-    content: string;
-    draggable: string;
-    hline: string;
-    linemarker: string;
-    vline: string;
-};
-export declare const SeriesClsNames: {
-    group: string;
-};
 /**
  * These are predefined color palettes for chart {@link Series} objects.
  *
@@ -713,6 +666,54 @@ export declare class _SvgRenderEngine implements IRenderEngine {
  */
 export declare class SvgRenderEngine extends _SvgRenderEngine {
 }
+export declare const AxisClsNames: {
+    axisX: string;
+    axisXLabels: string;
+    axisY: string;
+    axisYLabels: string;
+    gridline: string;
+    gridlineMinor: string;
+    line: string;
+    tick: string;
+    tickMinor: string;
+};
+export declare const DataLabelClsNames: {
+    border: string;
+    label: string;
+    labels: string;
+    line: string;
+};
+export declare const FlexChartClsNames: {
+    footer: string;
+    focusLayerHost: string;
+    header: string;
+    hostElement: string;
+    label: string;
+    legend: string;
+    plotArea: string;
+    title: string;
+    touchDisabled: string;
+};
+export declare const FlexPieClsNames: {
+    hostElement: string;
+    slice: string;
+    sliceGroup: string;
+};
+export declare const LegendClsNames: {
+    legend: string;
+    title: string;
+};
+export declare const LineMarkerClsNames: {
+    container: string;
+    content: string;
+    draggable: string;
+    hline: string;
+    linemarker: string;
+    vline: string;
+};
+export declare const SeriesClsNames: {
+    group: string;
+};
 /**
  * Represents the chart legend.
  */
@@ -784,6 +785,209 @@ export declare class Legend {
     private _invalidate;
     _getMaxSize(sz: number): number;
 }
+export interface AccessibleChartTypeOptions {
+    family?: 'financial' | 'radar';
+    supportsStacking?: boolean;
+}
+export interface ChartAccessibilityPoint {
+    index: number;
+    category?: any;
+    value?: any;
+    values?: any[];
+    details?: string;
+}
+export interface ChartAccessibilitySeries {
+    index: number;
+    name: string;
+    description?: string;
+    points: ChartAccessibilityPoint[];
+}
+export interface ChartAccessibilityLegendItem {
+    name: string;
+    seriesIndex?: number;
+    pointIndex?: number;
+    legendIndex?: number;
+}
+export interface ChartAccessibilityAnnotationItem {
+    label: string;
+    tooltip?: string;
+    shape?: any;
+}
+export interface ChartAccessibilityModel {
+    title: string;
+    type: string;
+    series: ChartAccessibilitySeries[];
+    legendItems: ChartAccessibilityLegendItem[];
+    annotations: ChartAccessibilityAnnotationItem[];
+}
+export interface ChartAccessibilityModelExtension {
+    _updateAccessibilityModel(model: ChartAccessibilityModel): void;
+    _disposeAccessibilityExtension?(): void;
+}
+export declare function _getDefaultAccessibilityAriaLabel(model: ChartAccessibilityModel): string;
+export declare function _getBaseAccessibilityModel(chart: any, chartType: string): ChartAccessibilityModel;
+export declare function _getUnnamedAccessibilitySeriesName(index: number): string;
+export declare function _getAccessibilityPointDescription(series: ChartAccessibilitySeries, point: ChartAccessibilityPoint, seriesIndex: number, pointIndex: number): string;
+export declare function _getAccessibilityLegendDescription(item: ChartAccessibilityLegendItem, index: number, count: number): string;
+export declare function _getAccessibilityAnnotationDescription(item: ChartAccessibilityAnnotationItem, index: number, count: number): string;
+export declare function _getAccessibleChartTypeName(typeOrKey: any, chartType?: number, stacking?: number, options?: AccessibleChartTypeOptions): string;
+export declare function _toAccessibilityText(value: any): string;
+export declare function _toAccessibilityTypeText(value: any): string;
+export declare function _formatAccessibilityValue(value: any): string;
+export declare function _getAccessibilityAriaLabels(): any;
+export declare function _formatAccessibilityLabel(template: string, data: any): string;
+export declare function _joinAccessibilityParts(parts: string[]): string;
+export declare type _ChartAccessibilityFocusRegion = 'chart' | 'title' | 'series' | 'annotation' | 'legend';
+export interface ChartAccessibilityFocusState {
+    region: _ChartAccessibilityFocusRegion;
+    seriesIndex?: number;
+    pointIndex?: number;
+    annotationIndex?: number;
+    legendIndex?: number;
+}
+export interface ChartAccessibilityFocusOwner {
+    hostElement: HTMLElement;
+    _currentRenderEngine?: any;
+    _accessibilityModel?: ChartAccessibilityModel;
+    _rectHeader: Rect;
+    _rectChart: Rect;
+    _getAccessibilitySeriesPointShape?(seriesIndex: number, pointIndex: number): _ChartAccessibilityFocusShape;
+    _getAccessibilityAnnotationShape?(item: ChartAccessibilityAnnotationItem, annotationIndex: number): _ChartAccessibilityFocusShape;
+    _getAccessibilityLegendItemShape?(item: ChartAccessibilityLegendItem, legendIndex: number): _ChartAccessibilityFocusShape;
+}
+export declare type _ChartAccessibilityFocusShape = ChartAccessibilityRectFocusShape | ChartAccessibilityCircleFocusShape | ChartAccessibilitySegmentFocusShape | ChartAccessibilityPolygonFocusShape;
+export interface ChartAccessibilityRectFocusShape {
+    type: 'rect';
+    rect: Rect;
+}
+export interface ChartAccessibilityCircleFocusShape {
+    type: 'circle';
+    center: Point;
+    radius: number;
+}
+export interface ChartAccessibilitySegmentFocusShape {
+    type: 'segment';
+    center: Point;
+    radius: number;
+    innerRadius?: number;
+    angle: number;
+    sweep: number;
+}
+export interface ChartAccessibilityPolygonFocusShape {
+    type: 'polygon';
+    points: Point[];
+}
+export declare class _ChartAccessibilityFocusManager {
+    private _owner;
+    private _state;
+    private _element;
+    private _layer;
+    constructor(owner: ChartAccessibilityFocusOwner);
+    update(state?: ChartAccessibilityFocusState): void;
+    refresh(): void;
+    clear(): void;
+    private _render;
+    private _renderShape;
+    private _ensureElement;
+    private _removeElement;
+    private _removeLayer;
+    private _inflateRect;
+    private _fitRectToSvg;
+    private _getSvgBounds;
+    private _getSvgLength;
+    private _getElementName;
+    private _isValidShape;
+    private _getSegmentPath;
+    private _normalizeSweep;
+    private _getPolygonPath;
+    private _getSvg;
+    private _getOverlaySvg;
+    private _ensureOverlayHostClass;
+    private _removeOverlayHostClass;
+    private _syncOverlaySvg;
+    private _inflatePolygon;
+}
+export declare function _getRectFocusShape(rect: Rect): _ChartAccessibilityFocusShape;
+export declare function _getFocusStateShape(owner: ChartAccessibilityFocusOwner, state: ChartAccessibilityFocusState): _ChartAccessibilityFocusShape;
+export declare function _getFocusShapeRect(shape: _ChartAccessibilityFocusShape): Rect;
+export declare function _getAreaShape(area: any): _ChartAccessibilityFocusShape;
+export interface ChartAccessibilityKeyboardOwner {
+    hostElement: HTMLElement;
+    _accessibilityModel: ChartAccessibilityModel;
+    addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void;
+    _activateAccessibilityLegendItem?(item: ChartAccessibilityLegendItem): boolean;
+    _getAccessibilityLegendItemState?(item: ChartAccessibilityLegendItem): boolean | null;
+    _shouldShowAccessibilityFocus?(): boolean;
+    _setAccessibilityFocus?(state: ChartAccessibilityFocusState): void;
+    _clearAccessibilityFocus?(): void;
+    _showAccessibilityTooltip?(state: ChartAccessibilityFocusState): void;
+    _hideAccessibilityTooltip?(): void;
+}
+export declare class _ChartAccessibilityKeyboardManager {
+    private _owner;
+    private _regions;
+    private _regionElements;
+    private _container;
+    private _statusElement;
+    private _pendingLegendAnnouncement;
+    private _seriesIndex;
+    private _pointIndex;
+    private _annotationIndex;
+    private _legendIndex;
+    private _activeRegion;
+    private _restoreFocusRegion;
+    private _restoreFocusLost;
+    private _tabKeyRegion;
+    private _tabKeyShift;
+    constructor(owner: ChartAccessibilityKeyboardOwner);
+    clear(): void;
+    update(): void;
+    activate(state: ChartAccessibilityFocusState): boolean;
+    private _ensureContainer;
+    private _removeUnusedRegions;
+    private _addRegion;
+    private _getRegionElement;
+    private _updateRegionSemantics;
+    private _onRegionFocus;
+    private _onRegionBlur;
+    private _onRegionKeyDown;
+    private _shouldRestoreScroll;
+    private _getScrollPositions;
+    private _restoreScrollPositions;
+    private _handleSeriesKey;
+    private _handleAnnotationKey;
+    private _handleLegendKey;
+    private _queueLegendAnnouncement;
+    private _announcePendingLegendChange;
+    private _isLegendActivationKey;
+    private _moveSeries;
+    private _moveLegendSeries;
+    private _getNearestSeriesPoint;
+    private _setSeriesFocusIndex;
+    private _setAnnotationFocusIndex;
+    private _setLegendFocusIndex;
+    private _updateRegionLabel;
+    private _setRegionLabel;
+    private _getRegionLabel;
+    private _getSeriesRegionLabel;
+    private _getAnnotationRegionLabel;
+    private _getLegendRegionLabel;
+    private _getCurrentLegendItemState;
+    private _getLegendItemState;
+    private _getLegendItemVisibilityLabel;
+    private _getRegion;
+    private _syncFocus;
+    private _queueFocusRestore;
+    private _clearFocusRestore;
+    private _completeFocusRestore;
+    private _shouldRestoreFocusAfterBlur;
+    private _shouldShowHostFocus;
+    private _isShiftTabbingToHost;
+    private _clearTabKeyState;
+    private _focusActiveRegionElement;
+    private _getCurrentSeries;
+    private _clearFocus;
+}
 /**
  * Represents the chart palette.
  */
@@ -948,6 +1152,14 @@ export declare class FlexChartBase<T = any> extends Control implements _IPalette
     _headerStyle: any;
     _footer: string;
     _footerStyle: any;
+    private _ariaLabel;
+    private _generatedAriaLabel;
+    _accessibilityModel: ChartAccessibilityModel;
+    private _accessibilityModelExtensions;
+    private _accessibilityKeyboard;
+    private _accessibilityFocus;
+    private _focusMode;
+    private _accessibilityHostFocusHandlerAdded;
     _legend: Legend;
     _defPalette: string[];
     _notifyCurrentChanged: boolean;
@@ -963,6 +1175,8 @@ export declare class FlexChartBase<T = any> extends Control implements _IPalette
     _tooltip: ChartTooltip;
     _chartRectId: string;
     private _skipLightClr;
+    private _showTooltipOnFocus;
+    private _accessibilityTooltipVisible;
     /**
      * Gets or sets the array or {@link ICollectionView} object that contains the data used to create the chart.
      */
@@ -1028,6 +1242,33 @@ export declare class FlexChartBase<T = any> extends Control implements _IPalette
      * Gets or sets the text displayed in the chart footer.
      */
     footer: string;
+    /**
+     * Gets or sets the accessible label for the chart host element.
+     *
+     * If this property is not specified, the chart generates a label from the chart
+     * title, chart type, and visible series names.
+     */
+    ariaLabel: string;
+    /**
+     * Gets or sets a value indicating whether the chart participates in page
+     * keyboard focus navigation using chart accessibility focus regions.
+     *
+     * When this property is set to <b>true</b>, chart accessibility regions are
+     * reachable from the page Tab order. When set to <b>false</b>, the chart keeps
+     * its original focus behavior and does not create chart accessibility regions.
+     *
+     * The default value for this property is <b>false</b>.
+     */
+    focusMode: boolean;
+    /**
+     * Gets or sets a value indicating whether the chart shows a tooltip for the
+     * active chart item when keyboard focus moves within the chart.
+     *
+     * This property takes effect only when {@link focusMode} is set to <b>true</b>.
+     *
+     * The default value for this property is <b>false</b>.
+     */
+    showTooltipOnFocus: boolean;
     /**
      * Gets or sets the style of the chart header.
      */
@@ -1122,6 +1363,10 @@ export declare class FlexChartBase<T = any> extends Control implements _IPalette
      * @param e The {@link RenderEventArgs} object used to render the chart.
      */
     onRendered(e: RenderEventArgs): void;
+    /**
+     * Disposes of the control by removing its association with the host element.
+     */
+    dispose(): void;
     /**
      * Occurs before the chart is bound to a new items source.
      */
@@ -1195,10 +1440,42 @@ export declare class FlexChartBase<T = any> extends Control implements _IPalette
      */
     onSelectionChanged(e?: EventArgs): void;
     onLostFocus(e?: EventArgs): void;
+    protected _setTabOrder(value: number): void;
+    protected _setIsDisabled(value: boolean): void;
     private _cvCollectionChanged;
     private _cvCurrentChanged;
     _bgColor(el: Element): string;
     _isTransparent(c: string): boolean;
+    _shouldShowAccessibilityFocus(): boolean;
+    private _updateHostAriaLabel;
+    protected _getAccessibleChartTypeName(): string;
+    protected _createAccessibilityModel(): ChartAccessibilityModel;
+    protected _isAccessibilityLegendVisible(): boolean;
+    private _updateAccessibilityModel;
+    _addAccessibilityModelExtension(extension: ChartAccessibilityModelExtension): void;
+    _removeAccessibilityModelExtension(extension: ChartAccessibilityModelExtension): void;
+    _refreshAccessibility(): void;
+    private _updateAccessibilityModelExtensions;
+    private _disposeAccessibilityModelExtensions;
+    private _updateAccessibilityKeyboard;
+    private _clearAccessibilityKeyboard;
+    private _updateFocusMode;
+    private _updateFocusModeTabOrder;
+    private _ensureAccessibilityHostFocusHandlers;
+    private _onAccessibilityHostFocus;
+    private _onAccessibilityHostBlur;
+    private _updateAccessibilityFocus;
+    _setAccessibilityFocus(state: ChartAccessibilityFocusState): void;
+    _clearAccessibilityFocus(): void;
+    protected _updateAccessibilityFocusFromState(state: ChartAccessibilityFocusState): void;
+    _getAccessibilitySeriesPointShape(_seriesIndex: number, _pointIndex: number): _ChartAccessibilityFocusShape;
+    _getAccessibilityAnnotationShape(item: ChartAccessibilityAnnotationItem, _annotationIndex: number): _ChartAccessibilityFocusShape;
+    _getAccessibilityLegendItemShape(item: any, legendIndex: number): _ChartAccessibilityFocusShape;
+    _showAccessibilityTooltip(state: ChartAccessibilityFocusState): void;
+    _hideAccessibilityTooltip(): void;
+    protected _getAccessibilityTooltipContent(_state: ChartAccessibilityFocusState): string;
+    protected _isAccessibilityTooltipContentCustom(state: ChartAccessibilityFocusState): boolean;
+    private _getAccessibilityTooltipBounds;
     /**
      * Gets a color from the palette by index.
      *
@@ -1237,6 +1514,7 @@ export declare class FlexChartBase<T = any> extends Control implements _IPalette
     _getHitTestLabel(_index: number): any;
     _refreshChart(): void;
     _drawTitle(engine: IRenderEngine, rect: Rect, title: string, style: any, isFooter: boolean): Rect;
+    private _getTitleFocusRect;
     /**
    * Converts page coordinates to control coordinates.
    *
@@ -1250,7 +1528,7 @@ export declare class FlexChartBase<T = any> extends Control implements _IPalette
     _toControl(pt: any, y?: number): Point;
     _highlightItems(items: any, cls: any, selected: boolean): void;
     _parseMargin(value: any): any;
-    _showToolTip(content: any, rect: any): void;
+    _showToolTip(content: any, rect: any, accessibility?: boolean, announceContent?: boolean): void;
     _hideToolTip(): void;
     private _clearTimeouts;
     _getHostOffset(): Point;
@@ -1328,6 +1606,7 @@ export declare class ChartTooltip extends Tooltip {
      * </pre>
      */
     content: any;
+    _isContentCustomized(): boolean;
     /**
      * Gets or sets the maximum distance from the element to display the tooltip.
      */
@@ -1342,6 +1621,8 @@ export declare class ChartTooltip extends Tooltip {
      * <b>getBoundingClientRect</b> method).
      */
     show(element: any, content: string, bounds?: Rect): void;
+    _showAccessibilityTooltip(element: any, content: string, bounds: Rect | undefined, announceContent?: boolean): void;
+    private _disablePointerEvents;
 }
 /**
  * Specifies the chart type.
@@ -1447,6 +1728,7 @@ export declare class FlexChartCore extends FlexChartBase {
     _xDataType: DataType;
     private _hitTester;
     private _lblAreas;
+    private _accessibilityVisualPoints;
     private _keywords;
     private _curPlotter;
     private _colRowLens;
@@ -1618,6 +1900,45 @@ export declare class FlexChartCore extends FlexChartBase {
     _isRotated(): boolean;
     _plotrectId: string;
     _getChartType(): ChartType;
+    private _handleHostClick;
+    private _getAccessibilityFocusStateFromClick;
+    private _getAccessibilityLegendFocusIndex;
+    private _selectLegendClickSeries;
+    private _toggleLegendClickSeries;
+    protected _getAccessibleChartTypeName(): string;
+    protected _getAccessibilityPointCategory(series: SeriesBase, pointIndex: number, xValues?: any[]): any;
+    protected _createAccessibilityModel(): ChartAccessibilityModel;
+    private _getAccessibilitySeriesCount;
+    private _getAccessibleSeriesName;
+    protected _getAccessibleSeriesChartTypeName(series: SeriesBase): string;
+    private _getAccessibleSeriesDescription;
+    private _getAccessibleSeriesPointDetails;
+    private _getAccessibleSeriesPointDetailsIncludeValue;
+    private _getAccessibleSeriesPoints;
+    private _isAccessibleSeriesPoint;
+    private _isAccessibleSeriesPointValue;
+    private _getAccessibleSeriesPointCategory;
+    private _getAccessibleSeriesPointValue;
+    private _getAccessibleSeriesHitTestInfo;
+    private _getAccessibleSeriesValueDimensions;
+    private _getAccessibleSeriesPointValues;
+    private _addAccessibilityLegendItems;
+    private _getAccessibleLegendItemName;
+    _activateAccessibilityLegendItem(item: ChartAccessibilityLegendItem): boolean;
+    private _dispatchAccessibilityLegendClick;
+    private _getAccessibilityLegendClickPoint;
+    private _getAccessibilityLegendScrollOffset;
+    _getAccessibilityLegendItemState(item: ChartAccessibilityLegendItem): boolean | null;
+    private _getAccessibilityLegendSeries;
+    private _toggleAccessibilityLegendSeries;
+    protected _getAccessibilityTooltipContent(state: ChartAccessibilityFocusState): string;
+    protected _isAccessibilityTooltipContentCustom(state: ChartAccessibilityFocusState): boolean;
+    _getAccessibilitySeriesPointShape(seriesIndex: number, pointIndex: number): _ChartAccessibilityFocusShape;
+    private _updateAccessibilityVisualPoints;
+    private _getAccessibilityLineAreas;
+    private _isAccessibilityAreaFocusable;
+    private _getAccessibilityPointKey;
+    private _getAccessibilitySeriesPointFallbackShape;
     _prepareRender(): void;
     _renderChart(engine: IRenderEngine, rect: Rect, applyElement: boolean): void;
     _getDesiredLegendSize(engine: IRenderEngine, isVertical: boolean, width: number, height: number): Size;
@@ -1981,6 +2302,7 @@ export declare class _CircleArea implements _IHitArea {
     constructor(center: Point, radius: number);
     setRadius(radius: number): void;
     readonly center: Point;
+    readonly radius: number;
     contains(pt: Point): boolean;
     distance(pt: Point): number;
 }
@@ -1990,6 +2312,7 @@ export declare class _LinesArea implements _IHitArea {
     tag: any;
     ignoreLabel: boolean;
     constructor(x: any, y: any);
+    distanceToPoint(pt: Point): number;
     contains(_pt: Point): boolean;
     distance(pt: Point): number;
 }
@@ -2419,6 +2742,7 @@ export declare class SeriesBase<T = any> implements _ISeries {
      */
     getDataRect(currentRect?: Rect, calculatedRect?: Rect): Rect;
     _getChartType(): ChartType;
+    _getAccessibleChartTypeName(): string;
     /**
      * Clears any cached data values.
      */
@@ -2566,6 +2890,17 @@ export declare class FlexPie extends FlexChartBase {
      * @param options A Javascript object containing initialization data for the control.
      */
     constructor(element: any, options?: any);
+    protected _getAccessibleChartTypeName(): string;
+    protected _createAccessibilityModel(): ChartAccessibilityModel;
+    protected _getAccessibilityTooltipContent(state: ChartAccessibilityFocusState): string;
+    private _isRenderablePiePointValue;
+    private _getAccessibilityFocusStateFromClick;
+    private _getPiePointValue;
+    private _getAccessibilityLegendFocusIndex;
+    _getAccessibilitySeriesPointShape(seriesIndex: number, pointIndex: number): _ChartAccessibilityFocusShape;
+    private _getTransformedPointFocusShape;
+    private _getAccessibilitySelectedOffset;
+    private _transformAccessibilityPoint;
     /**
      * Gets or sets the name of the property that contains the chart values.
      */
@@ -3428,6 +3763,7 @@ export declare class _FinancePlotter extends _BasePlotter {
     adjustLimits(dataInfo: _DataInfo, _plotRect: Rect): Rect;
     plotSeries(engine: IRenderEngine, ax: _IAxis, ay: _IAxis, series: _ISeries, _palette: _IPalette, _iser: number, _nser: number, _customRender?: Function): void;
     _drawSymbol(engine: IRenderEngine, ax: _IAxis, ay: _IAxis, si: number, pi: number, _fill: any, w: number, x: number, hi: number, lo: number, open: number, close: number, pointsLength: number): void;
+    protected _extendRectArea(area: _RectArea, x: number, y: number): void;
 }
 /**
  * Specifies the direction of the lines shown by the {@link LineMarker}.