scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
92 lines (91 loc) • 3.91 kB
TypeScript
import { ESeriesType } from "../../../types/SeriesType";
import { ETriangleSeriesDrawMode } from "../../../types/TriangleSeriesDrawMode";
import { TSciChart } from "../../../types/TSciChart";
import { IThemeProvider } from "../../Themes/IThemeProvider";
import { BaseRenderableSeries } from "./BaseRenderableSeries";
import { ILineSeriesDataLabelProviderOptions } from "./DataLabels/LineSeriesDataLabelProvider";
import { IHitTestProvider } from "./HitTest/IHitTestProvider";
import { IBaseRenderableSeriesOptions } from "./IBaseRenderableSeriesOptions";
import { ICustomTextureOptions } from "../../Drawing/BrushCache";
import { GradientParams } from "../../../Core/GradientParams";
import { HitTestInfo } from "./HitTest/HitTestInfo";
import { SeriesInfo } from "../../Model/ChartData/SeriesInfo";
export interface IFastTriangleRenderableSeriesOptions extends IBaseRenderableSeriesOptions {
/**
* Sets the fill color for triangles
*/
fill?: string;
/**
* Sets the draw mode for the {@link FastTriangleRenderableSeries}, one of {@link ETriangleSeriesDrawMode}
*/
drawMode?: ETriangleSeriesDrawMode;
/**
* Sets the number of vertices per polygon. Applies only for drawMode ETriangleSeriesDrawMode.Polygon
*/
polygonVertices?: number;
/**
* Options to pass to the {@link DataLabelProvider}. Set a style with font and size to enable per-point text for this series.
*/
dataLabels?: ILineSeriesDataLabelProviderOptions;
/**
* Not supported for Triangle Renderable Series
*/
stroke?: string;
/**
* Not supported for Triangle Renderable Series
*/
strokeThickness?: number;
/**
* Options that creates a custom texture brush
*/
customTextureOptions?: ICustomTextureOptions;
/**
* Gets or sets the fill as a gradient brush
*/
fillLinearGradient?: GradientParams;
}
/**
* The FastTriangleRenderableSeries is a specialized renderable series for displaying triangles in SciChart's High Performance Real-time
* {@link https://www.scichart.com/javascript-chart-features | JavaScript Charts}
*
* ---
* 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/fast-triangle-renderable-series/}
*/
export declare class FastTriangleRenderableSeries extends BaseRenderableSeries {
readonly type: ESeriesType;
private drawModeProperty;
private polygonVerticesProperty;
private fillProperty;
private fillLinearGradientProperty;
private customTextureOptionsProperty;
constructor(webAssemblyContext: TSciChart, options?: IFastTriangleRenderableSeriesOptions);
protected addDrawingProviders(webAssemblyContext: TSciChart, options?: IBaseRenderableSeriesOptions): void;
get drawMode(): ETriangleSeriesDrawMode;
set drawMode(value: ETriangleSeriesDrawMode);
get polygonVertices(): number;
set polygonVertices(value: number);
get fill(): string;
set fill(htmlColorCode: string);
/**
* Gets or sets the fill as a gradient brush
*/
get fillLinearGradient(): GradientParams;
/**
* Gets or sets the fill as a gradient brush
*/
set fillLinearGradient(gradientBrushParams: GradientParams);
/**
* Gets or sets options to use a custom texture brush
*/
get customTextureOptions(): ICustomTextureOptions;
/**
* Gets or sets options to use a custom texture brush
*/
set customTextureOptions(customTextureOptions: ICustomTextureOptions);
resolveAutoColors(index: number, maxSeries: number, theme: IThemeProvider): void;
/** @inheritDoc */
getSeriesInfo(hitTestInfo: HitTestInfo): SeriesInfo;
/** @inheritDoc */
toJSON(excludeData?: boolean): import("../../..").TSeriesDefinition;
protected newHitTestProvider(): IHitTestProvider;
}