scichart/Charting/Drawing/BrushCache.d.ts

Fast WebGL JavaScript Charting Library and Framework

import { GradientParams } from "../../Core/GradientParams";
import { SCRTBrush, SCRTTextureBrush } from "../../types/TSciChart";
import { CanvasTexture } from "../Visuals/TextureManager/CanvasTexture";
import { BaseCache } from "./BaseCache";
import { WebGlBrush } from "./WebGlBrush";
export interface ICustomTextureOptions {
    createTexture: (ctx: CanvasRenderingContext2D, options: {
        fill: string;
        opacity: number;
    } & any) => void;
    options: any;
    areEqual?: (prevOptions: any, newOptions: any) => boolean;
    textureHeight: number;
    textureWidth: number;
    repeat?: boolean;
    isPerPrimitive?: boolean;
}
/**
 * @ignore
 */
export declare class BrushCache extends BaseCache<WebGlBrush> {
    protected fill: string;
    protected opacity: number;
    protected fillLinearGradient: GradientParams;
    protected canvasTexture: CanvasTexture;
    protected textureHeightRatio: number;
    protected textureWidthRatio: number;
    protected customTextureOptions: ICustomTextureOptions;
    get value(): WebGlBrush;
    private defaultCustomEquals;
    /**
     * Creates or fetches a new brush with the specified params
     * @param fill
     * @param opacity
     * @param textureHeightRatio
     * @param textureWidthRatio
     * @param fillLinearGradient
     */
    create(fill: string, opacity: number, textureHeightRatio?: number, textureWidthRatio?: number, fillLinearGradient?: GradientParams, customTextureOptions?: ICustomTextureOptions): WebGlBrush;
    createCustomBrush(): SCRTTextureBrush;
    invalidateCache(): void;
    reset(): void;
    delete(): void;
    private createSolidBrush;
    private createGradientBrush;
    private createGradientTexture;
}
/**
 * Retrieves a native {@link WebGlBrush} Brush from the provided {@link BrushCache} cache object
 * @param BrushCache The object that stores a brush
 * @returns new or existing instance of {@link WebGlPen}}
 */
export declare const getWebGlBrushFromCache: (cache: BrushCache) => WebGlBrush;
/**
 * Retrieves a native {@link SCRTBrush} Brush from the provided {@link BrushCache} cache object.
 * The retrieved entity is a wrapper around {@link SCRTPen}
 * @param cache The object that stores a brush
 * @returns new or existing instance of {@link SCRTBrush}}
 */
export declare const getScrtBrushFromCache: (cache: BrushCache) => SCRTBrush;
/**
 * Creates a native {@link SCRTBrush} brush from html color code string passed in and caches it
 * @param cache The object that will store a brush
 * @param fill The HTML Color code
 * @param opacity The opacity factor.
 * @param textureHeightRatio The height ratio of the main canvas to the WebGl canvas.
 * @param textureWidthRatio The width ratio of the main canvas to the WebGl canvas.
 * @param fillGradientLinear The gradient params.
 * @returns new or existing instance of {@link SCRTBrush}}
 */
export declare const createBrushInCache: (cache: BrushCache, fill: string, opacity: number, textureHeightRatio?: number, textureWidthRatio?: number, fillGradientLinear?: GradientParams, customTextureOptions?: ICustomTextureOptions) => SCRTBrush;