igniteui-webcomponents-charts
Version:
Ignite UI Web Components charting components for building rich data visualizations using TypeScript APIs.
98 lines (95 loc) • 4.34 kB
TypeScript
import { IgRect } from "igniteui-webcomponents-core";
import { IgPoint } from "igniteui-webcomponents-core";
import { IgcAxisComponent } from './igc-axis-component';
import { CategoryAxisBase } from './CategoryAxisBase';
/**
* Represents the base class for all IgxDataChartComponent category-based axes.
*/
export declare abstract class IgcCategoryAxisBaseComponent extends IgcAxisComponent {
constructor();
private _chartLevelData;
provideData(data: any[]): void;
private updateDataSource;
private _dataSource;
set dataSource(value: any);
get dataSource(): any;
connectedCallback(): void;
disconnectedCallback(): void;
private static _observedAttributesIgcCategoryAxisBaseComponent;
static get observedAttributes(): string[];
/**
* @hidden
*/
get i(): CategoryAxisBase;
/**
* Gets if the current axis is a continuous rather than a discrete scale
*/
get isContinuous(): boolean;
/**
* Checks if the axis is of category axis type
*/
get isCategory(): boolean;
/**
* Gets the number of items in the current category axis items source.
*/
get itemsCount(): number;
set itemsCount(v: number);
/**
* Gets or sets the amount of space between adjacent categories for the current axis object.
* The gap is silently clamped to the range [0, 1] when used.
*
* Use the `Gap` property to configure the spacing between items on a category axis with item spacing.
*
* A `Gap` of 0 allocates no space between items. A `Gap` of 1 allocates a space between items equal to the width of one item.
*
* To set the item spacing to 75% the width of one item, set the `Gap` to 0.75, as in this code:
*/
get gap(): number;
set gap(v: number);
/**
* Gets or sets the maximum gap value to allow. This defaults to 1.0.
*/
get maximumGap(): number;
set maximumGap(v: number);
/**
* Gets or sets the minimum amount of pixels to use for the gap between categories, if possible.
*/
get minimumGapSize(): number;
set minimumGapSize(v: number);
/**
* Gets or sets the amount of overlap between adjacent categories for the current axis object.
* The overlap is silently clamped to the range [-1, 1] when used.
*
* Use the `Overlap` property to configure the spacing between items on a category axis with item spacing and more than one series.
*
* An `Overlap` of 0 places grouped items adjacent to each other. An `Overlap` of 1 places grouped items in the same axis space, completely overlapping. An `Overlap` of -1 places a space between grouped items equal to the width of one item.
*
* To place grouped items with 75% overlap, set the `Overlap` to 0.75, as in this code:
*/
get overlap(): number;
set overlap(v: number);
/**
* Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode.
*
* `UseClusteringMode` applies grouping and spacing to a category axis equivalent to the grouping that occurs when grouping series, such as ColumnSeries, are used.
*
* Try setting it on an axis displaying financial series to adjust the spacing on the left and right sides of the axis:
*/
get useClusteringMode(): boolean;
set useClusteringMode(v: boolean);
getFullRange(): number[];
getCategoryBoundingBox(point: IgPoint, useInterpolation: boolean, singularWidth: number): IgRect;
getCategoryBoundingBoxHelper(point: IgPoint, useInterpolation: boolean, singularWidth: number, isVertical: boolean): IgRect;
/**
* Unscales a value from screen space into axis space.
* @param unscaledValue * The scaled value in screen coordinates to unscale into axis space.
*/
unscaleValue(unscaledValue: number): number;
notifySetItem(index: number, oldItem: any, newItem: any): void;
/**
* Used to manually notify the axis that the data source has reset or cleared its items.
*/
notifyClearItems(): void;
notifyInsertItem(index: number, newItem: any): void;
notifyRemoveItem(index: number, oldItem: any): void;
}