igniteui-webcomponents-charts
Version:
Ignite UI Web Components charting components for building rich data visualizations using TypeScript APIs.
238 lines (229 loc) • 9.26 kB
TypeScript
import { IgRect } from "igniteui-webcomponents-core";
import { IgPoint } from "igniteui-webcomponents-core";
import { IgcNumericAngleAxisComponent } from "./igc-numeric-angle-axis-component";
import { IgcNumericRadiusAxisComponent } from "./igc-numeric-radius-axis-component";
import { TrendLineType } from "igniteui-webcomponents-core";
import { ScatterItemSearchMode } from "./ScatterItemSearchMode";
import { IgcAssigningPolarStyleEventArgs } from "./igc-assigning-polar-style-event-args";
import { IgcAssigningPolarMarkerStyleEventArgs } from "./igc-assigning-polar-marker-style-event-args";
import { IgcMarkerSeriesComponent } from "./igc-marker-series-component";
import { PolarBase } from "./PolarBase";
import { IgcAxisComponent } from "./igc-axis-component";
/**
* Represents the base class from which all IgxDataChartComponent polar series are derived.
*/
export declare abstract class IgcPolarBaseComponent extends IgcMarkerSeriesComponent {
/**
* @hidden
*/
get i(): PolarBase;
constructor();
connectedCallback(): void;
disconnectedCallback(): void;
private static _observedAttributesIgcPolarBaseComponent;
static get observedAttributes(): string[];
/**
* Checks if this series is a polar series
*/
get isPolar(): boolean;
/**
* Gets or sets the path to use to find the angle values for the series.
*/
get angleMemberPath(): string;
set angleMemberPath(v: string);
/**
* Gets or sets the path to use to get the radius values for the series.
*/
get radiusMemberPath(): string;
set radiusMemberPath(v: string);
/**
* Gets or sets the highlighted radius value mapping property for the current series object.
*/
get highlightedRadiusMemberPath(): string;
set highlightedRadiusMemberPath(v: string);
/**
* Gets or sets the highlighted angle value mapping property for the current series object.
*/
get highlightedAngleMemberPath(): string;
set highlightedAngleMemberPath(v: string);
/**
* Gets the effective angle axis for the current series object.
*/
get angleAxis(): IgcNumericAngleAxisComponent;
set angleAxis(v: IgcNumericAngleAxisComponent);
private _angleAxisName;
/**
* Gets or sets the name to use to resolve angleAxis from markup.
*/
get angleAxisName(): string;
set angleAxisName(v: string);
/**
* Gets the effective radius axis for the current series object.
*/
get radiusAxis(): IgcNumericRadiusAxisComponent;
set radiusAxis(v: IgcNumericRadiusAxisComponent);
private _radiusAxisName;
/**
* Gets or sets the name to use to resolve radiusAxis from markup.
*/
get radiusAxisName(): string;
set radiusAxisName(v: string);
/**
* Gets or sets whether Cartesian Interpolation should be used rather than Archimedian
* spiral based interpolation.
*/
get useCartesianInterpolation(): boolean;
set useCartesianInterpolation(v: boolean);
/**
* Gets or sets the maximum number of markers displayed by the current series.
* If more than the specified number of markers are visible, the polar series will automatically
* choose a representative set.
*/
get maximumMarkers(): number;
set maximumMarkers(v: number);
/**
* Gets or sets the trend type for the current series object.
*/
get trendLineType(): TrendLineType;
set trendLineType(v: TrendLineType);
/**
* Gets or sets the brush that specifies how the current series
* object's trend line is drawn.
*/
get trendLineBrush(): string;
set trendLineBrush(v: string);
/**
* Gets the effective TrendLineBrush for this series.
*/
get actualTrendLineBrush(): string;
set actualTrendLineBrush(v: string);
/**
* Gets or sets the thickness of the current series object's trend line.
*/
get trendLineThickness(): number;
set trendLineThickness(v: number);
/**
* Gets or sets a collection of double values that indicate the pattern of dashes and gaps that
* is used to draw the trend line for the current series object.
*/
get trendLineDashArray(): number[];
set trendLineDashArray(v: number[]);
/**
* Gets or sets the moving average period for the current series object.
*/
get trendLinePeriod(): number;
set trendLinePeriod(v: number);
/**
* Sets or Gets the Trendline Z index.
*/
get trendLineZIndex(): number;
set trendLineZIndex(v: number);
/**
* Gets or sets whether to clip the series to the bounds.
* Setting this to true can effect performance.
*/
get clipSeriesToBounds(): boolean;
set clipSeriesToBounds(v: boolean);
get actualItemSearchMode(): ScatterItemSearchMode;
set actualItemSearchMode(v: ScatterItemSearchMode);
/**
* Gets or sets the mode the series will use to find the closest point to the cursor.
*/
get itemSearchMode(): ScatterItemSearchMode;
set itemSearchMode(v: ScatterItemSearchMode);
/**
* Gets or sets the threshold to use when searching for items using ItemSearchMode.
*/
get itemSearchThreshold(): number;
set itemSearchThreshold(v: number);
/**
* Gets or sets whether this Polar series should allow custom style overrides of its individual visuals.
*/
get isCustomPolarStyleAllowed(): boolean;
set isCustomPolarStyleAllowed(v: boolean);
/**
* Gets or sets whether this Polar series should allow custom style overrides of its individual marker visuals.
*/
get isCustomPolarMarkerStyleAllowed(): boolean;
set isCustomPolarMarkerStyleAllowed(v: boolean);
/**
* Gets or sets the label displayed before series' radius value in the Data Legend.
*/
get radiusMemberAsLegendLabel(): string;
set radiusMemberAsLegendLabel(v: string);
/**
* Gets or sets the label displayed before series' angle value in the Data Legend.
*/
get angleMemberAsLegendLabel(): string;
set angleMemberAsLegendLabel(v: string);
/**
* Gets or sets the unit displayed after series' radius value in the Data Legend.
*/
get radiusMemberAsLegendUnit(): string;
set radiusMemberAsLegendUnit(v: string);
/**
* Gets or sets the unit displayed after series' angle value in the Data Legend.
*/
get angleMemberAsLegendUnit(): string;
set angleMemberAsLegendUnit(v: string);
bindAxes(axes: IgcAxisComponent[]): void;
findByName(name: string): any;
protected _styling(container: any, component: any, parent?: any): void;
/**
* If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided.
* @param world * The world coordinates for which to get a value marker bounding box for
*/
getSeriesValueMarkerBoundingBox(world: IgPoint): IgRect;
/**
* Gets an unscaled position in terms of axis values from a viewport position.
* @param pos * The viewport relative position
*/
getUnscaledPosition(pos: IgPoint): IgPoint;
/**
* Scrolls the requested item into view, if possible.
* @param item * The item to scroll into view.
*/
scrollIntoView(item: any): boolean;
/**
* Gets the item that is the best match for the specified world coordinates.
* @param world * The world coordinates to use.
*/
getItem(world: IgPoint): any;
/**
* Gets the index of the item that resides at the provided world coordinates.
* @param world * The world coordinates of the requested item.
*/
getItemIndex(world: IgPoint): number;
getExactItemIndex(world: IgPoint): number;
getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint;
getItemValue(item: any, memberPathName: string): any;
/**
* Gets the value of a requested member path from the series.
* @param memberPathName * The property name of a valid member path for the series
*/
getMemberPathValue(memberPathName: string): string;
/**
* Determine if object can be used as RadiusAxis
* @param axis * The object to check
*/
canUseAsRadiusAxis(axis: any): boolean;
/**
* Determine if object can be used as AngleAxis
* @param axis * The object to check
*/
canUseAsAngleAxis(axis: any): boolean;
private _assigningPolarStyle;
private _assigningPolarStyle_wrapped;
/**
* Event raised when Assigning Category Style
*/
get assigningPolarStyle(): (s: IgcPolarBaseComponent, e: IgcAssigningPolarStyleEventArgs) => void;
set assigningPolarStyle(ev: (s: IgcPolarBaseComponent, e: IgcAssigningPolarStyleEventArgs) => void);
private _assigningPolarMarkerStyle;
private _assigningPolarMarkerStyle_wrapped;
/**
* Event raised when Assigning Polar Marker Style
*/
get assigningPolarMarkerStyle(): (s: IgcPolarBaseComponent, e: IgcAssigningPolarMarkerStyleEventArgs) => void;
set assigningPolarMarkerStyle(ev: (s: IgcPolarBaseComponent, e: IgcAssigningPolarMarkerStyleEventArgs) => void);
}