@carto/airship-bridge/dist/vl/histogram/BaseHistogramFilter.d.ts

Airship bridge to other libs (CARTO VL, CARTO.js)

import { BaseFilter } from '../base/BaseFilter';
/**
 * Base class for Filters based on Airship Histogram Widgets
 *
 * @export
 * @abstract
 * @class BaseHistogramFilter
 * @extends {BaseFilter}
 * @template T Type of the selection. Typicall an array of number or strings
 */
export declare abstract class BaseHistogramFilter<T> extends BaseFilter {
    protected _buckets: number;
    protected _carto: any;
    protected _widget: any;
    protected _selection: T;
    protected _dataLayer: any;
    protected _inputExpression: any;
    protected _totals: boolean;
    protected _weight: number | string;
    /**
     * Creates an instance of BaseHistogramFilter.
     * @param {('categorical' | 'numerical')} type Whether it is a categorical or a numerical histogram
     * @param {*} carto The CARTO VL namespace
     * @param {*} layer A CARTO VL layer
     * @param {(any | string)} histogram An Airship Histogram or TimeSeries HTML element, or a selector
     * @param {string} columnName The column to pull data from
     * @param {*} source A CARTO VL source
     * @param {boolean} [readOnly=true] Whether the widget will be able to filter the visualization or not
     * @param {object} [inputExpression=null] VL Expression to use instead of s.prop for the histogram input
     * @memberof BaseHistogramFilter
     */
    constructor(type: 'categorical' | 'numerical', carto: any, layer: any, histogram: any | string, columnName: string, source: any, readOnly: boolean, weight: number | string, showTotals?: boolean, inputExpression?: object);
    removeHistogramLayer(): void;
    setDataLayer(layer: any): void;
    protected _getLegendConfig(): {
        samples: number;
    };
    /**
     * Custom implementation of a histogram selection changed event. This differs on every type of histogram
     *
     * @protected
     * @abstract
     * @param {CustomEvent<any>} evt A Custom Event with the Histogram Selection
     * @memberof BaseHistogramFilter
     */
    protected abstract selectionChanged(evt: CustomEvent<any>): any;
    /**
     * Function called right after the Data Layer has been set, allows for each type of histogram filter to
     * customize the updated handling.
     *
     * @protected
     * @abstract
     * @memberof BaseHistogramFilter
     */
    protected abstract bindDataLayer(): any;
}