Interface CoordinateSystemMaster

src/coord/CoordinateSystem.ts:54–119

 * one or multiple `cartesian2d`s, which are `CoordinateSystem`s.
 */
export interface CoordinateSystemMaster {

    // FIXME current dimensions must be string[].
    // check and unify the definition.
    // Should be the same as its coordinateSystemCreator.
    dimensions: DimensionName[];

    model?: ComponentModel;

    // Injected if required.
    boxCoordinateSystem?: CoordinateSystem;

    update?: (ecModel: GlobalModel, api: ExtensionAPI) => void;

    // This methods is also responsible for determining whether this
    // coordinate system is applicable to the given `finder`.
    // Each coordinate system will be tried, until one returns non-
    // null/undefined value.
    // Aslo support
    //  const resultNumber = convertToPixel({someAxis: 0}, number);
    convertToPixel?(
        ecModel: GlobalModel,
        finder: ParsedModelFinder,
        value: Parameters<CoordinateSystem['dataToPoint']>[0],
        opt?: unknown
    ): ReturnType<CoordinateSystem['dataToPoint']> | number | NullUndefined;

    // This methods is also responsible for determining whether this
    // coordinate system is applicable to the given `finder`.
    // Each coordinate system will be tried, until one returns non-
    // null/undefined value.
    convertToLayout?(
        ecModel: GlobalModel,
        finder: ParsedModelFinder,
        value: Parameters<NonNullable<CoordinateSystem['dataToLayout']>>[0],
        opt?: unknown
    ): ReturnType<NonNullable<CoordinateSystem['dataToLayout']>> | NullUndefined;

    // This methods is also responsible for determining whether this
    // coordinate system is applicable to the given `finder`.
    // Each coordinate system will be tried, until one returns non-
    // null/undefined value.
    convertFromPixel?(
        ecModel: GlobalModel,
        finder: ParsedModelFinder,
        pixelValue: Parameters<NonNullable<CoordinateSystem['pointToData']>>[0],
        opt?: unknown
    ): ReturnType<NonNullable<CoordinateSystem['pointToData']>> | NullUndefined;

    // @param point Point in global pixel coordinate system.
    // The signature of this method should be the same as `CoordinateSystemExecutive`
    containPoint(point: number[]): boolean;

    // Must be implemented when `axisPointerEnabled` is `true`.
    getAxes?: () => Axis[];

    axisPointerEnabled?: boolean;