@uwdata/mosaic-plot
Version:
A Mosaic-powered plotting framework based on Observable Plot.
78 lines • 3.22 kB
TypeScript
/**
* Helper method for setting a channel option in a Plot specification.
* Checks if a constant value or a data field is needed.
* Also avoids misinterpretation of data values as color names.
* @param {*} c a visual encoding channel spec
* @param {object} columns named data column arrays
* @returns the Plot channel option
*/
export function channelOption(c: any, columns: object): any;
/**
* Default query construction for a mark.
* Tracks aggregates by checking fields for an aggregate flag.
* If aggregates are found, groups by all non-aggregate fields.
* @param {*} channels array of visual encoding channel specs.
* @param {*} table the table to query.
* @param {*} skip an optional array of channels to skip.
* Mark subclasses can skip channels that require special handling.
* @returns {SelectQuery} a Query instance
*/
export function markQuery(channels: any, table: any, skip?: any): SelectQuery;
/**
* Generate an array of Plot mark specifications.
* @returns {object[]}
*/
export function markPlotSpec(type: any, detail: any, channels: any, data: any, options?: {}): object[];
export function isDataArray(source: any): source is any[];
export class Mark extends MosaicClient {
constructor(type: any, source: any, encodings: any, reqs?: {});
type: any;
reqs: {};
source: any;
channels: any[];
detail: Set<any>;
params: Set<any>;
data: {
numRows: number;
columns: Record<string, unknown[] | Int8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike> | Uint8ClampedArray<ArrayBufferLike> | Int16Array<ArrayBufferLike> | Uint16Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike> | Float32Array<ArrayBufferLike> | Float64Array<ArrayBufferLike>>;
} | {
numRows: number;
values: unknown[] | Int8Array<ArrayBufferLike> | Uint8Array<ArrayBufferLike> | Uint8ClampedArray<ArrayBufferLike> | Int16Array<ArrayBufferLike> | Uint16Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | Uint32Array<ArrayBufferLike> | Float32Array<ArrayBufferLike> | Float64Array<ArrayBufferLike>;
};
/**
* @param {import('../plot.js').Plot} plot The plot.
* @param {number} index
*/
setPlot(plot: import("../plot.js").Plot, index: number): void;
plot: import("../plot.js").Plot;
index: number;
sourceTable(): any;
hasOwnData(): boolean;
hasFieldInfo(): boolean;
channel(channel: any): any;
channelField(channel: any, { exact }?: {
exact?: boolean;
}): any;
prepare(): Promise<any>;
_fieldInfo: boolean;
/**
* Return a query specifying the data needed by this Mark client.
* @param {*} [filter] The filtering criteria to apply in the query.
* @returns {*} The client query
*/
query(filter?: any): any;
queryPending(): this;
/**
* Provide query result data to the mark.
*/
queryResult(data: any): this;
update(): Promise<void>;
/**
* Generate an array of Plot mark specifications.
* @returns {object[]}
*/
plotSpecs(): object[];
}
import type { SelectQuery } from '@uwdata/mosaic-sql';
import { MosaicClient } from '@uwdata/mosaic-core';
//# sourceMappingURL=Mark.d.ts.map