Interface SeriesModel

src/model/Series.ts:82–147

* NOTICE: * - prefix `__` can be used to avoid conflicts with possible outside subclasses. * - All of these methods are optional - null-check is needed.

 *  - All of these methods are optional - null-check is needed.
 */
interface SeriesModel {

    preventIncremental(): boolean;

    __preparePipelineContext(
        view: ChartView,
        pipeline: Pick<Pipeline, 'progressiveEnabled' | 'threshold'>
    ): PipelineContext;

    /**
     * If `true`, a default `startValue` (`0`) is used if not specified in ec option,
     * and axis extent will union it.
     * Otherwise, `startValue` will be included in the union of axis extent only if
     * it is explicitly specified in ec option.
     *
     * @see {AxisBaseOptionCommon['startValue']} for more info.
     */
    __requireStartValue(axis: Axis): boolean;

    /**
     * See tooltip.
     * Implement it if needed.
     * @return Point of tooltip. null/undefined can be returned.
     */
    getTooltipPosition(dataIndex: number): number[];

    /**
     * Get data indices for show tooltip content. See tooltip.
     * Implement it if needed.
     */
    getAxisTooltipData(
        dim: DimensionName[],
        value: ScaleDataValue,
        baseAxis: Axis
    ): {
        dataIndices: number[],
        nestestValue: any
    };

    /**
     * Get position for marker
     */
    getMarkerPosition(
        value: ScaleDataValue[],
        dims?: typeof dimPermutations[number],
        startingAtTick?: boolean
    ): number[];

    /**
     * Get legend icon symbol according to each series type
     */
    getLegendIcon(opt: LegendIconParams): ECSymbol | Group;

    /**
     * See `component/brush/selector.js`
     * Defined the brush selector for this series.
     */
    brushSelector(