vega-lite/build/stack.d.ts

Vega-Lite is a concise high-level language for interactive visualization.

import { NonPositionChannel } from './channel.js';
import { FieldName, TypedFieldDef } from './channeldef.js';
import { Encoding } from './encoding.js';
import { Mark, MarkDef } from './mark.js';
declare const STACK_OFFSET_INDEX: {
    readonly zero: 1;
    readonly center: 1;
    readonly normalize: 1;
};
export type StackOffset = keyof typeof STACK_OFFSET_INDEX;
export declare function isStackOffset(s: string): s is StackOffset;
export interface StackProperties {
    /** Dimension axis of the stack. */
    groupbyChannels: ('x' | 'y' | 'theta' | 'radius' | 'xOffset' | 'yOffset')[];
    /** Field for groupbyChannel. */
    groupbyFields: Set<FieldName>;
    /** Measure axis of the stack. */
    fieldChannel: 'x' | 'y' | 'theta' | 'radius';
    /** Stack-by fields e.g., color, detail */
    stackBy: {
        fieldDef: TypedFieldDef<string>;
        channel: NonPositionChannel;
    }[];
    /**
     * See `stack` property of Position Field Def.
     */
    offset: StackOffset;
    /**
     * Whether this stack will produce impute transform
     */
    impute: boolean;
}
export declare const STACKABLE_MARKS: Set<"text" | "arc" | "area" | "image" | "line" | "rect" | "rule" | "trail" | "bar" | "point" | "tick" | "circle" | "square" | "geoshape">;
export declare const STACK_BY_DEFAULT_MARKS: Set<"text" | "arc" | "area" | "image" | "line" | "rect" | "rule" | "trail" | "bar" | "point" | "tick" | "circle" | "square" | "geoshape">;
export declare function stack(m: Mark | MarkDef, encoding: Encoding<string>): StackProperties;
export {};
//# sourceMappingURL=stack.d.ts.map