@genome-spy/core 0.77.0 → 0.79.0

package/dist/src/view/legendView.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @param {object} options
+ * @param {LegendEntry[]} [options.entries]
+ * @param {import("../spec/channel.js").ChannelWithScale} options.channel
+ * @param {Partial<Record<import("../spec/channel.js").ChannelWithScale, string>>} [options.symbolChannels]
+ * @param {SymbolLegendStyle} [options.symbolStyle]
+ * @param {"point" | "stroke"} [options.symbolGeometry]
+ * @param {LegendConfig} options.legend
+ * @param {string} [options.format]
+ * @param {import("../spec/channel.js").Type} options.dataType
+ * @param {import("../types/viewContext.js").default} options.context
+ * @returns {LegendRootSpec}
+ */
+export function createSymbolLegendSpec({ entries, channel, symbolChannels, symbolStyle, symbolGeometry, legend, format, dataType, context, }: {
+    entries?: LegendEntry[];
+    channel: import("../spec/channel.js").ChannelWithScale;
+    symbolChannels?: Partial<Record<import("../spec/channel.js").ChannelWithScale, string>>;
+    symbolStyle?: SymbolLegendStyle;
+    symbolGeometry?: "point" | "stroke";
+    legend: LegendConfig;
+    format?: string;
+    dataType: import("../spec/channel.js").Type;
+    context: import("../types/viewContext.js").default;
+}): LegendRootSpec;
+/**
+ * @param {object} options
+ * @param {import("../spec/channel.js").ChannelWithScale} options.channel
+ * @param {LegendConfig} options.legend
+ * @param {string} [options.format]
+ * @param {import("../types/viewContext.js").default} options.context
+ * @returns {LegendRootSpec}
+ */
+export function createGradientLegendSpec({ channel, legend, format, context }: {
+    channel: import("../spec/channel.js").ChannelWithScale;
+    legend: LegendConfig;
+    format?: string;
+    context: import("../types/viewContext.js").default;
+}): LegendRootSpec;
+/**
+ * @param {{
+ *     getPerpendicularSize: () => number,
+ *     getOffset: () => number
+ * } | undefined} legendView
+ * @returns {number}
+ */
+export function getExternalLegendOverhang(legendView: {
+    getPerpendicularSize: () => number;
+    getOffset: () => number;
+} | undefined): number;
+export class LegendRegionView extends ContainerView<import("../spec/view.js").ContainerSpec> {
+    /**
+     * @param {import("../spec/legend.js").LegendOrient} orient
+     * @param {number} stackSpacing
+     * @param {import("../types/viewContext.js").default} context
+     * @param {import("./containerView.js").default} layoutParent
+     * @param {import("./view.js").default} dataParent
+     */
+    constructor(orient: import("../spec/legend.js").LegendOrient, stackSpacing: number, context: import("../types/viewContext.js").default, layoutParent: import("./containerView.js").default, dataParent: import("./view.js").default);
+    orient: import("../spec/legend.js").LegendOrient;
+    /**
+     * @param {LegendView} legendView
+     */
+    addLegendView(legendView: LegendView): void;
+    getPerpendicularSize(): number;
+    getOffset(): number;
+    getParallelSize(): number;
+    #private;
+}
+export default class LegendView extends ContainerView<import("../spec/view.js").ContainerSpec> {
+    /**
+     * @param {object} props
+     * @param {LegendEntry[]} [props.entries]
+     * @param {import("../spec/channel.js").ChannelWithScale} props.channel
+     * @param {Partial<Record<import("../spec/channel.js").ChannelWithScale, string>>} [props.symbolChannels]
+     * @param {SymbolLegendStyle} [props.symbolStyle]
+     * @param {"point" | "stroke"} [props.symbolGeometry]
+     * @param {"symbol" | "gradient"} [props.type]
+     * @param {LegendConfig} props.legend
+     * @param {string} [props.format]
+     * @param {import("../spec/channel.js").Type} props.dataType
+     * @param {import("../types/viewContext.js").default} context
+     * @param {import("./containerView.js").default} layoutParent
+     * @param {import("./view.js").default} dataParent
+     * @param {import("./view.js").ViewOptions} [options]
+     */
+    constructor({ entries, channel, symbolChannels, symbolStyle, symbolGeometry, type, legend, format, dataType, }: {
+        entries?: LegendEntry[];
+        channel: import("../spec/channel.js").ChannelWithScale;
+        symbolChannels?: Partial<Record<import("../spec/channel.js").ChannelWithScale, string>>;
+        symbolStyle?: SymbolLegendStyle;
+        symbolGeometry?: "point" | "stroke";
+        type?: "symbol" | "gradient";
+        legend: LegendConfig;
+        format?: string;
+        dataType: import("../spec/channel.js").Type;
+    }, context: import("../types/viewContext.js").default, layoutParent: import("./containerView.js").default, dataParent: import("./view.js").default, options?: import("./view.js").ViewOptions);
+    legendProps: import("../spec/legend.js").LegendConfig;
+    getPerpendicularSize(): number;
+    getOffset(): number;
+    /**
+     * @param {() => boolean} predicate
+     */
+    setActivePredicate(predicate: () => boolean): void;
+    isActive(): boolean;
+    getStackedParallelSize(): number;
+    /**
+     * Defers legend data updates that only serve layout packing. Scale-backed
+     * legend marks keep using the live scale while callers run smooth layout
+     * transitions.
+     *
+     * TODO: Prefer optimizing layout and render batching to support partial
+     * updates, so transition callers do not need to suppress legend dataflow.
+     *
+     * @returns {() => void}
+     */
+    suspendLayoutDataUpdates(): () => void;
+    #private;
+}
+export type LegendConfig = import("../spec/legend.js").LegendConfig;
+export type LegendEntry = import("./legend/legendEntries.js").LegendEntry;
+export type LegendRootSpec = (import("../spec/view.js").VConcatSpec | import("../spec/view.js").HConcatSpec) & {
+    view: import("../spec/view.js").ViewBackground;
+};
+export type SymbolLegendStyle = {
+    mark?: Partial<import("../spec/mark.js").PointProps>;
+    encoding?: Partial<import("../spec/channel.js").Encoding>;
+};
+export type MeasuredLabels = {
+    maxWidth: number;
+    maxEntryWidth: number;
+    maxY: number;
+};
+import ContainerView from "./containerView.js";
+//# sourceMappingURL=legendView.d.ts.map

package/dist/src/view/legendView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"legendView.d.ts","sourceRoot":"","sources":["../../../src/view/legendView.js"],"names":[],"mappings":"AAuVA;;;;;;;;;;;;GAYG;AACH,8IAXG;IAAgC,OAAO,GAA/B,WAAW,EAAE;IAC0C,OAAO,EAA9D,OAAO,oBAAoB,EAAE,gBAAgB;IACoC,cAAc,GAA/F,OAAO,CAAC,MAAM,CAAC,OAAO,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC1C,WAAW,GAAvC,iBAAiB;IACY,cAAc,GAA3C,OAAO,GAAG,QAAQ;IACI,MAAM,EAA5B,YAAY;IACK,MAAM,GAAvB,MAAM;IACqC,QAAQ,EAAnD,OAAO,oBAAoB,EAAE,IAAI;IACkB,OAAO,EAA1D,OAAO,yBAAyB,EAAE,OAAO;CACjD,GAAU,cAAc,CA+M1B;AAED;;;;;;;GAOG;AACH,+EANG;IAA+D,OAAO,EAA9D,OAAO,oBAAoB,EAAE,gBAAgB;IACvB,MAAM,EAA5B,YAAY;IACK,MAAM,GAAvB,MAAM;IAC6C,OAAO,EAA1D,OAAO,yBAAyB,EAAE,OAAO;CACjD,GAAU,cAAc,CAgO1B;AAED;;;;;;GAMG;AACH,sDANW;IACJ,oBAAoB,EAAE,MAAM,MAAM,CAAC;IACnC,SAAS,EAAE,MAAM,MAAM,CAAA;CAC1B,GAAG,SAAS,GACH,MAAM,CAMlB;AAED;IASI;;;;;;OAMG;IACH,oBANW,OAAO,mBAAmB,EAAE,YAAY,gBACxC,MAAM,WACN,OAAO,yBAAyB,EAAE,OAAO,gBACzC,OAAO,oBAAoB,EAAE,OAAO,cACpC,OAAO,WAAW,EAAE,OAAO,EAqBrC;IALG,iDAAoB;IAuBxB;;OAEG;IACH,0BAFW,UAAU,QAWpB;IA2DD,+BAuBC;IAED,oBAOC;IAED,0BAcC;;CAiDJ;AAED;IAyBI;;;;;;;;;;;;;;;OAeG;IACH,gHAdG;QAA8B,OAAO,GAA7B,WAAW,EAAE;QACwC,OAAO,EAA5D,OAAO,oBAAoB,EAAE,gBAAgB;QACkC,cAAc,GAA7F,OAAO,CAAC,MAAM,CAAC,OAAO,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAC5C,WAAW,GAArC,iBAAiB;QACU,cAAc,GAAzC,OAAO,GAAG,QAAQ;QACY,IAAI,GAAlC,QAAQ,GAAG,UAAU;QACD,MAAM,EAA1B,YAAY;QACG,MAAM,GAArB,MAAM;QACmC,QAAQ,EAAjD,OAAO,oBAAoB,EAAE,IAAI;KACzC,WAAQ,OAAO,yBAAyB,EAAE,OAAO,gBACzC,OAAO,oBAAoB,EAAE,OAAO,cACpC,OAAO,WAAW,EAAE,OAAO,YAC3B,OAAO,WAAW,EAAE,WAAW,EA0DzC;IATG,sDAAyB;IA6G7B,+BAEC;IAED,oBAEC;IAED;;OAEG;IACH,8BAFW,MAAM,OAAO,QAIvB;IAQD,oBAEC;IAED,iCAUC;IAkED;;;;;;;;;OASG;IACH,4BAFa,MAAM,IAAI,CAyBtB;;CA+BJ;2BA9wCY,OAAO,mBAAmB,EAAE,YAAY;0BACxC,OAAO,2BAA2B,EAAE,WAAW;6BAC/C,CAAC,OAAO,iBAAiB,EAAE,WAAW,GAAG,OAAO,iBAAiB,EAAE,WAAW,CAAC,GAAG;IACxF,IAAI,EAAE,OAAO,iBAAiB,EAAE,cAAc,CAAA;CACjD;gCACS;IACN,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,iBAAiB,EAAE,UAAU,CAAC,CAAC;IACrD,QAAQ,CAAC,EAAE,OAAO,CAAC,OAAO,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CAC5D;;cA0wCM,MAAM;mBACN,MAAM;UACN,MAAM;;0BAp2CU,oBAAoB"}