vega-lite
Version:
Vega-Lite is a concise high-level language for interactive visualization.
63 lines • 2.85 kB
TypeScript
/**
* Utility files for producing Vega ValueRef for marks
*/
import type { SignalRef } from 'vega';
import { Channel, PolarPositionChannel, PositionChannel } from '../../../channel.js';
import { ChannelDef, DatumDef, FieldDefBase, FieldRefOption, SecondaryChannelDef, SecondaryFieldDef, TypedFieldDef, Value } from '../../../channeldef.js';
import { Config } from '../../../config.js';
import { Mark, MarkDef } from '../../../mark.js';
import { StackProperties } from '../../../stack.js';
import { VgValueRef } from '../../../vega.schema.js';
import { ScaleComponent } from '../../scale/component.js';
export declare function midPointRefWithPositionInvalidTest(params: MidPointParams & {
channel: PositionChannel | PolarPositionChannel;
}): VgValueRef | VgValueRef[];
export declare function datumDefToExpr(datumDef: DatumDef<string>): string;
export declare function valueRefForFieldOrDatumDef(fieldDef: FieldDefBase<string> | DatumDef<string>, scaleName: string, opt: FieldRefOption, encode: {
offset?: number | VgValueRef;
band?: number | boolean | SignalRef;
}): VgValueRef;
/**
* Signal that returns the middle of a bin from start and end field. Should only be used with x and y.
*/
export declare function interpolatedSignalRef({ scaleName, fieldOrDatumDef, fieldOrDatumDef2, offset, startSuffix, endSuffix, bandPosition, }: {
scaleName: string;
fieldOrDatumDef: TypedFieldDef<string>;
fieldOrDatumDef2?: SecondaryFieldDef<string>;
startSuffix?: string;
endSuffix?: string;
offset: number | SignalRef | VgValueRef;
bandPosition: number | SignalRef;
}): VgValueRef;
export declare function binSizeExpr({ scaleName, fieldDef }: {
scaleName: string;
fieldDef: TypedFieldDef<string>;
}): string;
export interface MidPointParams {
channel: Channel;
channelDef: ChannelDef;
channel2Def?: SecondaryChannelDef<string>;
markDef: MarkDef<Mark, SignalRef>;
config: Config<SignalRef>;
scaleName: string;
scale: ScaleComponent;
stack?: StackProperties;
offset?: number | SignalRef | VgValueRef;
defaultRef: VgValueRef | (() => VgValueRef);
bandPosition?: number | SignalRef;
}
/**
* @returns {VgValueRef} Value Ref for xc / yc or mid point for other channels.
*/
export declare function midPoint({ channel, channelDef, channel2Def, markDef, config, scaleName, scale, stack, offset, defaultRef, bandPosition, }: MidPointParams): VgValueRef;
/**
* Convert special "width" and "height" values in Vega-Lite into Vega value ref.
*/
export declare function widthHeightValueOrSignalRef(channel: Channel, value: Value | SignalRef): SignalRef | {
value: string | number | boolean | string[] | number[] | import("vega").LinearGradient | import("vega").RadialGradient;
} | {
field: {
group: string;
};
};
//# sourceMappingURL=valueref.d.ts.map