@nova-ui/charts/renderers/side-indicator-renderer.d.ts

Nova Charts is a library created to provide potential consumers with solutions for various data visualizations that conform with the Nova Design Language. It's designed to solve common patterns identified by UX designers, but also be very flexible so that

import { Subject } from "rxjs";
import { IRenderSeries } from "./types";
import { XYRenderer } from "./xy-renderer";
import { Scales } from "../core/common/scales/types";
import { DataAccessor, IDataAccessors, IDataSeries, ILasagnaLayer, IRendererConfig, IRendererEventPayload, ISeriesAccessors, SeriesAccessor } from "../core/common/types";
/** Interface for side indicator data accessors */
export interface ISideIndicatorDataAccessors extends IDataAccessors {
    /** Accessor indicating whether the side indicator should be active */
    active: DataAccessor;
}
/** Interface for side indicator series accessors */
export interface ISideIndicatorSeriesAccessors extends ISeriesAccessors {
    /** Indicates the start value of the side indicator */
    start: SeriesAccessor;
    /** Indicates the end value of the side indicator */
    end: SeriesAccessor;
    /** Indicates the active color of the side indicator */
    activeColor: SeriesAccessor;
    /** Optional accessor indicating the inactive color of the side indicator. A grayscale filter is applied to the active color by default */
    inactiveColor?: SeriesAccessor;
}
/** Interface for side indicator accessors */
export interface ISideIndicatorAccessors {
    /** Accessors for the side indicator data */
    data: ISideIndicatorDataAccessors;
    /** Accessors for the side indicator series */
    series: ISideIndicatorSeriesAccessors;
}
/** Standard definition for side indicator series and data accessors */
export declare class SideIndicatorAccessors implements ISideIndicatorAccessors {
    data: ISideIndicatorDataAccessors;
    series: ISideIndicatorSeriesAccessors;
    constructor();
}
/**
 * Renderer for drawing threshold side indicators
 */
export declare class SideIndicatorRenderer extends XYRenderer<ISideIndicatorAccessors> {
    /** @deprecated As of Nova v9, use RenderLayerName.unclippedData enum value instead. Removal: NUI-5753 */
    static SIDE_INDICATORS_LAYER: string;
    private DEFAULT_CONFIG;
    /**
     * Creates an instance of SideIndicatorRenderer.
     * @param {IRendererConfig} [config={}] Renderer configuration object
     */
    constructor(config?: IRendererConfig);
    /** See {@link Renderer#draw} */
    draw(renderSeries: IRenderSeries<ISideIndicatorAccessors>, rendererSubject: Subject<IRendererEventPayload>): void;
    /** See {@link Renderer#getDataPointIndex} */
    getDataPointIndex(series: IDataSeries<ISideIndicatorAccessors>, values: {
        [p: string]: any;
    }, scales: Scales): number;
    /** See {@link Renderer#getRequiredLayers} */
    getRequiredLayers(): ILasagnaLayer[];
}