@genome-spy/core 0.14.2 → 0.18.0

package/dist/style.css

@@ -1 +1 @@
-.genome-spy{font-family:system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";position:relative}.genome-spy canvas{transform:scale(1);opacity:1;transition:transform .6s,opacity .6s}.genome-spy .loading-message{position:absolute;top:0;bottom:0;left:0;right:0;display:flex;align-items:center;justify-content:center}.genome-spy .loading-message .message{color:#666;opacity:0;transition:opacity .7s}.genome-spy.loading canvas{transform:scale(.95);opacity:0}.genome-spy.loading .loading-message .message{opacity:1}.genome-spy.loading .ellipsis{animation:blinker 1s linear infinite}@keyframes blinker{50%{opacity:0}}.genome-spy .tooltip{position:absolute;max-width:450px;overflow:hidden;background:#f6f6f6;padding:10px;font-size:13px;box-shadow:0 3px 15px #00000036;pointer-events:none;z-index:100}.genome-spy .tooltip>:last-child{margin-bottom:0}.genome-spy .tooltip>.title{padding-bottom:5px;margin-bottom:5px;border-bottom:1px dashed #b6b6b6}.genome-spy .tooltip .summary{font-size:12px}.genome-spy .tooltip table{border-collapse:collapse}.genome-spy .tooltip table:first-child{margin-top:0}.genome-spy .tooltip table th,.genome-spy .tooltip table td{padding:2px .4em;vertical-align:top}.genome-spy .tooltip table th:first-child,.genome-spy .tooltip table td:first-child{padding-left:0}.genome-spy .tooltip table th{text-align:left;font-weight:bold}.genome-spy .tooltip .color-legend{display:inline-block;width:.8em;height:.8em;margin-left:.4em;box-shadow:0 0 3px 1px #fff}.genome-spy .tooltip .attributes .hovered{background-color:#e0e0e0}.genome-spy .tooltip .na{color:#aaa;font-style:italic;font-size:80%}.genome-spy .gene-track-tooltip .summary{font-size:90%}.genome-spy .message-box{display:flex;align-items:center;justify-content:center;position:absolute;top:0;height:100%;width:100%}.genome-spy .message-box>div{border:1px solid red;padding:10px;background:#fff0f0}
+.genome-spy{font-family:system-ui,Segoe UI,Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji",Segoe UI Symbol;position:relative}.genome-spy canvas{transform:scale(1);opacity:1;transition:transform .6s,opacity .6s}.genome-spy .loading-message{position:absolute;top:0;bottom:0;left:0;right:0;display:flex;align-items:center;justify-content:center}.genome-spy .loading-message .message{color:#666;opacity:0;transition:opacity .7s}.genome-spy.loading canvas{transform:scale(.95);opacity:0}.genome-spy.loading .loading-message .message{opacity:1}.genome-spy.loading .ellipsis{animation:blinker 1s linear infinite}@keyframes blinker{50%{opacity:0}}.genome-spy .tooltip{position:absolute;max-width:450px;overflow:hidden;background:#f6f6f6;padding:10px;font-size:13px;box-shadow:0 3px 15px #00000036;pointer-events:none;z-index:100}.genome-spy .tooltip>:last-child{margin-bottom:0}.genome-spy .tooltip>.title{padding-bottom:5px;margin-bottom:5px;border-bottom:1px dashed #b6b6b6}.genome-spy .tooltip .summary{font-size:12px}.genome-spy .tooltip table{border-collapse:collapse}.genome-spy .tooltip table:first-child{margin-top:0}.genome-spy .tooltip table th,.genome-spy .tooltip table td{padding:2px .4em;vertical-align:top}.genome-spy .tooltip table th:first-child,.genome-spy .tooltip table td:first-child{padding-left:0}.genome-spy .tooltip table th{text-align:left;font-weight:700}.genome-spy .tooltip .color-legend{display:inline-block;width:.8em;height:.8em;margin-left:.4em;box-shadow:0 0 3px 1px #fff}.genome-spy .tooltip .attributes .hovered{background-color:#e0e0e0}.genome-spy .tooltip .na{color:#aaa;font-style:italic;font-size:80%}.genome-spy .gene-track-tooltip .summary{font-size:90%}.genome-spy .message-box{display:flex;align-items:center;justify-content:center;position:absolute;top:0;height:100%;width:100%}.genome-spy .message-box>div{border:1px solid red;padding:10px;background:#fff0f0}

package/package.json

@@ -7,12 +7,13 @@
   },
   "contributors": [],
   "license": "BSD-2-Clause",
-  "version": "0.14.2",
+  "version": "0.18.0",
   "main": "dist/index.js",
   "module": "src/index.js",
   "exports": {
     ".": "./src/index.js",
-    "./*": "./src/*"
+    "./*": "./src/*",
+    "./schema.json": "./dist/schema.json"
   },
   "files": [
     "dist/",
@@ -20,15 +21,16 @@
   ],
   "repository": {
     "type": "git",
-    "url": "github:tuner/genome-spy",
+    "url": "github:genome-spy/genome-spy",
     "directory": "packages/core"
   },
   "scripts": {
     "dev": "node dev-server.js",
-    "build": "vite build",
-    "prepublishOnly": "npm run build && npm run build:schema",
+    "build": "vite build && npm run build:schema",
+    "prepublishOnly": "npm run build",
+    "test:tsc": "tsc -p tsconfig.json",
     "checkSpec": "tsc --allowJs --checkJs --strict --noEmit --moduleResolution node --target es6 src/spec/root.d.ts",
-    "build:schema": "mkdir -p dist && ts-json-schema-generator --path 'src/spec/*.ts' --type ViewSpec > dist/genome-spy-schema.json"
+    "build:schema": "mkdir -p dist && ts-json-schema-generator --path 'src/spec/*.ts' --type RootSpec > dist/schema.json"
   },
   "dependencies": {
     "@types/d3-array": "^3.0.2",
@@ -50,5 +52,5 @@
     "vega-scale": "^7.1.1",
     "vega-util": "^1.16.0"
   },
-  "gitHead": "bd13241dba46e380539bc40ac7bef65eced23fc0"
+  "gitHead": "ae445fc90ed7640ad9c3b39e81560d81126ebbeb"
 }

package/src/data/sources/dataUtils.js

@@ -8,8 +8,9 @@
 export function getFormat(params) {
     const format = { ...params.format };
 
-    format.type = format.type || extractTypeFromUrl(params.url);
-    format.parse = format.parse || "auto";
+    format.type ??= isUrlData(params) && extractTypeFromUrl(params.url);
+    // @ts-expect-error
+    format.parse ??= "auto";
 
     if (!format.type) {
         throw new Error(
@@ -22,10 +23,56 @@ export function getFormat(params) {
 }
 
 /**
- * @param {string} url
+ * @param {string | string[]} url
  */
 export function extractTypeFromUrl(url) {
+    if (Array.isArray(url)) {
+        url = url[0];
+    }
+
     if (url) {
         return url.match(/\.(csv|tsv|json)/)?.[1];
     }
 }
+
+export const makeWrapper = (/** @type {any} */ d) =>
+    typeof d != "object" ? scalarWrapper : nopWrapper;
+
+const scalarWrapper = (
+    /** @type {import("@genome-spy/core/spec/channel").Scalar} */ x
+) => ({ data: x });
+
+const nopWrapper = (/** @type {import("../flowNode").Datum} */ x) => x;
+
+/**
+ * @param {import("../../spec/data").DataFormat} dataFormat
+ * @return {dataFormat is import("../../spec/data").CsvDataFormat}
+ */
+export function isCsvDataFormat(dataFormat) {
+    return dataFormat.type == "csv" || dataFormat.type == "tsv";
+}
+
+/**
+ * @param {import("../../spec/data").DataFormat} dataFormat
+ * @return {dataFormat is import("../../spec/data").DsvDataFormat}
+ */
+export function isDsvDataFormat(dataFormat) {
+    return dataFormat.type == "dsv";
+}
+
+/**
+ * @param {import("../../spec/data").DataFormat} dataFormat
+ * @return {dataFormat is import("../../spec/data").JsonDataFormat}
+ */
+export function isJsonDataFormat(dataFormat) {
+    return dataFormat.type == "json";
+}
+
+/**
+ *
+ * @param {import("../../spec/data").DataSource} dataSource
+ * @return {dataSource is import("../../spec/data").UrlData}
+ */
+export function isUrlData(dataSource) {
+    return "url" in dataSource;
+}

package/src/data/sources/dynamicCallbackSource.js

@@ -1,4 +1,5 @@
 import DataSource from "./dataSource";
+import { makeWrapper } from "./dataUtils";
 
 /**
  * @param {Partial<import("../../spec/data").Data>} data
@@ -41,7 +42,7 @@ export default class DynamicCallbackSource extends DataSource {
 
         for (const d of iterable) {
             if (!wrap) {
-                wrap = typeof d != "object" ? (x) => ({ data: x }) : (x) => x;
+                wrap = makeWrapper(d);
             }
 
             this._propagate(wrap(d));

package/src/data/sources/dynamicSource.js

@@ -1,4 +1,5 @@
 import DataSource from "./dataSource";
+import { makeWrapper } from "./dataUtils";
 
 /**
  * @param {Partial<import("../../spec/data").Data>} data
@@ -21,7 +22,7 @@ export default class DynamicSource extends DataSource {
 
         for (const d of iterable) {
             if (!wrap) {
-                wrap = typeof d != "object" ? (x) => ({ data: x }) : (x) => x;
+                wrap = makeWrapper(d);
             }
 
             this._propagate(wrap(d));

package/src/data/sources/inlineSource.js

@@ -1,5 +1,5 @@
 import { read } from "vega-loader";
-import { getFormat } from "./dataUtils";
+import { getFormat, makeWrapper } from "./dataUtils";
 import DataSource from "./dataSource";
 
 /**
@@ -31,16 +31,14 @@ export default class InlineSource extends DataSource {
 
         let data = [];
 
+        /** @type {(x: any) => import("../flowNode").Datum} */
         let wrap = (x) => x;
 
         if (Array.isArray(values)) {
             if (values.length > 0) {
                 data = values;
                 // TODO: Should check the whole array and abort if types are heterogeneous
-                if (typeof values[0] != "object") {
-                    // Wrap scalars to objects
-                    wrap = (d) => ({ data: d });
-                }
+                wrap = makeWrapper(values[0]);
             }
         } else if (typeof values == "object") {
             data = [values];

package/src/data/sources/namedSource.js

@@ -1,4 +1,5 @@
 import DataSource from "./dataSource";
+import { makeWrapper } from "./dataUtils";
 
 /**
  * @param {Partial<import("../../spec/data").Data>} data
@@ -39,18 +40,13 @@ export default class NamedSource extends DataSource {
     loadSynchronously() {
         const data = this._getValues();
 
-        /**
-         * @param {any} x
-         */
+        /** @type {(x: any) => import("../flowNode").Datum} */
         let wrap = (x) => x;
 
         if (Array.isArray(data)) {
             if (data.length > 0) {
                 // TODO: Should check the whole array and abort if types are heterogeneous
-                if (typeof data[0] != "object") {
-                    // Wrap scalars to objects
-                    wrap = (d) => ({ data: d });
-                }
+                wrap = makeWrapper(data[0]);
             }
         } else {
             throw new Error(

package/src/data/sources/urlSource.js

@@ -40,7 +40,7 @@ export default class UrlSource extends DataSource {
                     baseURL: this.baseUrl,
                 })
                     .load(url)
-                    .catch((e) => {
+                    .catch((/** @type {Error} */ e) => {
                         // TODO: Include baseurl in the error message. Should be normalized, however.
                         throw new Error(
                             `Cannot fetch: ${this.baseUrl}${url}: ${e.message}`

package/src/data/transforms/aggregate.js

@@ -49,6 +49,7 @@ export default class AggregateTransform extends FlowNode {
         const groupFieldAccessors = groupby.map((f) => field(f));
 
         // TODO: Fix case where no group fields are specified
+        // @ts-expect-error
         const groups = d3group(this.buffer, ...groupFieldAccessors);
 
         for (const [group, data] of iterateNestedMaps(groups)) {

package/src/data/transforms/flattenDelimited.js

@@ -47,6 +47,7 @@ export default class FlattenDelimitedTransform extends FlowNode {
             const flatLen = splitFields[0].length;
 
             for (let ri = 0; ri < flatLen; ri++) {
+                /** @type {import("../flowNode").Datum} */
                 const newRow = Object.assign({}, datum);
                 for (let fi = 0; fi < accessors.length; fi++) {
                     newRow[as[fi]] = splitFields[fi][ri];
@@ -57,6 +58,11 @@ export default class FlattenDelimitedTransform extends FlowNode {
     }
 }
 
+/**
+ *
+ * @param {any[]} splitFields
+ * @param {unknown} row
+ */
 function validateSplit(splitFields, row) {
     const splitLengths = splitFields.map((f) => f.length);
     if (!splitLengths.every((x) => x == splitLengths[0])) {

package/src/data/transforms/regexFold.js

@@ -48,7 +48,7 @@ export default class RegexFoldTransform extends FlowNode {
          * @param {any} datum
          */
         const detectColumns = (datum) => {
-            const colNames = Object.keys(datum);
+            const colNames = /** @type {string[]} */ (Object.keys(datum));
 
             /** @type {Map<string, string[]>} */
             const sampleColMap = new Map();

package/src/data/transforms/stack.js

@@ -43,7 +43,7 @@ export default class StackTransform extends FlowNode {
             ? compare(params.sort.field, params.sort.order)
             : undefined;
 
-        const valueAccessor = params.field ? field(params.field) : (d) => 1;
+        const valueAccessor = params.field ? field(params.field) : () => 1;
 
         const groupFields = params.groupby.map((f) => field(f));
 
@@ -52,7 +52,7 @@ export default class StackTransform extends FlowNode {
         ).map((a) => a[1]);
 
         /** @type {(datum: any) => boolean} */
-        let inclusionPredicate = (datum) => true;
+        let inclusionPredicate = (_datum) => true;
 
         if (params.baseField) {
             const baseAccessor = field(params.baseField);
@@ -108,7 +108,7 @@ export default class StackTransform extends FlowNode {
                 break;
             default:
                 offsetF = (value, sum) => value;
-                sumF = (values, accessor) => 1;
+                sumF = (_values, _accessor) => 1;
         }
 
         for (const group of groups) {

package/src/embedApi.d.ts

@@ -0,0 +1,59 @@
+import { ScaleResolutionApi } from "./view/scaleResolutionApi";
+import { TooltipHandler } from "./tooltip/tooltipHandler";
+import { RootSpec } from "./spec/root";
+
+/**
+ * Embeds GenomeSpy into the DOM
+ *
+ * @param el HTMLElement or a query selector
+ * @param spec A spec object or an URL to a JSON spec
+ * @param options Options
+ */
+export type EmbedFunction = (
+    el: HTMLElement | string,
+    spec: RootSpec | string,
+    options?: EmbedOptions
+) => EmbedResult;
+
+export interface EmbedOptions {
+    /**
+     * A function that allows retrieval of named data sources.
+     *
+     * TODO: Support dynamic updates, i.e., pushing new data.
+     */
+    namedDataProvider?: (name: string) => any[];
+
+    /**
+     * Custom tooltip handlers. Use `"default"` to override the default handler
+     */
+    tooltipHandlers?: Record<string, TooltipHandler>;
+}
+
+/**
+ * An API for controlling the embedded GenomeSpy instance.
+ */
+export interface EmbedResult {
+    /**
+     * Releases all resources and unregisters event listeners, etc.
+     */
+    finalize: () => void;
+
+    /**
+     * Adds an event listener, which is called when the user interacts with a mark
+     * instance. Currently, only `"click"` events are supported. The callback receives
+     * an event object as its first (and only) parameter. Its `datum` property
+     * contains the datum that the user interacted with.
+     */
+    addEventListener: (type: string, listener: (event: any) => void) => void;
+
+    /**
+     * Removes a registered event listener.
+     */
+    removeEventListener: (type: string, listener: (event: any) => void) => void;
+
+    /**
+     * Returns a named _ScaleResolution_ object that allows for attaching event
+     * listeners and controlling the scale domain.
+     */
+    getScaleResolutionByName: (name: string) => ScaleResolutionApi;
+}

package/src/encoder/accessor.js

@@ -21,8 +21,9 @@ export default class AccessorFactory {
         this.register((channelDef) => {
             if (isFieldDef(channelDef)) {
                 try {
-                    /** @type {Accessor} */
-                    const accessor = field(channelDef.field);
+                    const accessor = /** @type {Accessor} */ (
+                        field(channelDef.field)
+                    );
                     accessor.constant = false;
                     accessor.fields = accessorFields(accessor);
                     return accessor;
@@ -40,8 +41,8 @@ export default class AccessorFactory {
 
         this.register((channelDef) => {
             if (isDatumDef(channelDef)) {
-                /** @type {Accessor} */
-                const accessor = constant(channelDef.datum);
+                const c = /** @type {any} */ (constant(channelDef.datum));
+                const accessor = /** @type {Accessor} */ (c);
                 accessor.constant = true; // Can be optimized downstream
                 accessor.fields = [];
                 return accessor;
@@ -75,8 +76,7 @@ export default class AccessorFactory {
  * @param {string} expr
  */
 function createExpressionAccessor(expr) {
-    /** @type {Accessor} */
-    const accessor = createFunction(expr);
+    const accessor = /** @type {Accessor} */ (createFunction(expr));
     accessor.constant = accessor.fields.length == 0; // Not bulletproof, eh
     return accessor;
 }

package/src/encoder/encoder.js

@@ -5,7 +5,7 @@ import createIndexer from "../utils/indexer";
  * @typedef {Object} EncoderMetadata
  * @prop {boolean} constant True if the accessor returns the same value for all objects
  * @prop {boolean} constantValue True the encoder returns a "value" without a scale
- * @prop {function} invert
+ * @prop {(value: import("../spec/channel").Scalar) => import("../spec/channel").Scalar} invert
  * @prop {VegaScale} [scale]
  * @prop {import("./accessor").Accessor} accessor 
  * @prop {function(any):number} [indexer] Converts ordinal values to index numbers
@@ -17,7 +17,7 @@ import createIndexer from "../utils/indexer";
  *
  * @typedef {object} ScaleMetadata
  * @prop {string} type Scale type
- * @prop {boolean} fp64 Whether to use emulated 64 bit floating point in WebGL
+ * @prop {boolean} [fp64] Whether to use emulated 64 bit floating point in WebGL
  * 
  * @typedef {(
     import("d3-scale").ScaleContinuousNumeric<any, any> |
@@ -37,7 +37,7 @@ import createIndexer from "../utils/indexer";
     import("d3-scale").ScalePoint<any>
     )} D3Scale
  * 
- * @typedef {D3Scale & ScaleMetadata} VegaScale
+ * @typedef {(D3Scale | import("../genome/scaleIndex").ScaleIndex | import("../genome/scaleLocus").ScaleLocus) & ScaleMetadata} VegaScale
  * 
  * @typedef {import("../spec/channel").Channel} Channel
  */
@@ -85,7 +85,7 @@ export default function createEncoders(mark, encoding) {
 
 /**
  *
- * @param {import("../view/viewUtils").ChannelDef} channelDef
+ * @param {import("../spec/channel").ChannelDef} channelDef
  * @param {any} scale
  * @param {import("./accessor").Accessor} accessor
  * @param {Channel} channel
@@ -96,7 +96,8 @@ export function createEncoder(channelDef, scale, accessor, channel) {
     let encoder;
 
     if (isValueDef(channelDef)) {
-        encoder = /** @type {Encoder} */ ((datum) => channelDef.value);
+        const value = channelDef.value;
+        encoder = /** @type {Encoder} */ ((datum) => value);
         encoder.constant = true;
         encoder.constantValue = true;
         encoder.accessor = undefined;
@@ -121,7 +122,7 @@ export function createEncoder(channelDef, scale, accessor, channel) {
                 // TODO: pass the found values back to the scale/resolution
                 const indexer = createIndexer();
                 indexer.addAll(scale.domain());
-                encoder.indexer = (d) => indexer(accessor(d));
+                encoder.indexer = indexer;
             }
 
             encoder.constant = accessor.constant;
@@ -153,6 +154,7 @@ export function createEncoder(channelDef, scale, accessor, channel) {
     encoder.applyMetadata = (target) => {
         for (const prop in encoder) {
             if (prop in encoder) {
+                // @ts-ignore
                 target[prop] = encoder[prop];
             }
         }
@@ -174,7 +176,7 @@ export function isValueDef(channelDef) {
 
 /**
  * @param {import("../spec/channel").ChannelDef} channelDef
- * @returns {channelDef is import("../spec/channel").FieldDef}
+ * @returns {channelDef is import("../spec/channel").FieldDefBase<string>}
  */
 export function isFieldDef(channelDef) {
     return channelDef && "field" in channelDef;
@@ -193,6 +195,7 @@ export function isDatumDef(channelDef) {
  * @returns {channelDef is import("../spec/channel").ChannelDefWithScale}
  */
 export function isChannelDefWithScale(channelDef) {
+    // TODO: Not accurate, fix
     return (
         isFieldDef(channelDef) ||
         isDatumDef(channelDef) ||
@@ -231,26 +234,55 @@ export function isExprDef(channelDef) {
 }
 
 /**
- * @type {Channel[]}
+ * @type {import("../spec/channel").PrimaryPositionalChannel[]}
  */
 export const primaryPositionalChannels = ["x", "y"];
 
+/**
+ * @type {import("../spec/channel").SecondaryPositionalChannel[]}
+ */
+export const secondaryPositionalChannels = ["x2", "y2"];
+
+/**
+ * @type {import("../spec/channel").PositionalChannel[]}
+ */
+export const positionalChannels = [
+    ...primaryPositionalChannels,
+    ...secondaryPositionalChannels,
+];
+
+/**
+ * @param {Channel} channel
+ * @returns {channel is import("../spec/channel").PrimaryPositionalChannel}
+ */
+export function isPrimaryPositionalChannel(channel) {
+    // @ts-expect-error
+    return primaryPositionalChannels.includes(channel);
+}
+
+/**
+ * @param {Channel} channel
+ * @returns {channel is import("../spec/channel").PositionalChannel}
+ */
+export function isPositionalChannel(channel) {
+    // @ts-expect-error
+    return positionalChannels.includes(channel);
+}
+
 /**
  * Map primary channels to secondarys
  *
- * @type {Partial<Record<Channel, Channel>>}
+ * @type {Partial<Record<Channel, import("../spec/channel").SecondaryPositionalChannel>>}
  */
 export const secondaryChannels = {
     x: "x2",
     y: "y2",
-    size: "size2",
-    color: "color2",
 };
 
 /**
  * Map secondary channels to primaries
  *
- * @type {Record<Channel, Channel>}
+ * @type {Partial<Record<Channel, Channel>>}
  */
 export const primaryChannels = Object.fromEntries(
     Object.entries(secondaryChannels).map((entry) => [entry[1], entry[0]])
@@ -282,10 +314,10 @@ export function getSecondaryChannel(primaryChannel) {
  * Finds the primary channel for the provided channel, which may be
  * the primary or secondary.
  *
- * @param {Channel} maybeSecondary
+ * @param {Channel} channel
  */
-export function getPrimaryChannel(maybeSecondary) {
-    return primaryChannels[maybeSecondary] || maybeSecondary;
+export function getPrimaryChannel(channel) {
+    return primaryChannels[channel] ?? channel;
 }
 
 /**
@@ -299,13 +331,6 @@ export function getChannelWithSecondarys(channel) {
         : [channel];
 }
 
-/**
- * @param {Channel} channel
- */
-export function isPositionalChannel(channel) {
-    return primaryPositionalChannels.includes(getPrimaryChannel(channel));
-}
-
 /**
  * @param {Channel} channel
  */

package/src/genome/scaleIndex.d.ts

@@ -0,0 +1,38 @@
+export default function scaleIndex(): ScaleIndex;
+
+export interface ScaleIndex {
+    (value: number): number;
+
+    invert(x: number): number;
+
+    domain(): number[];
+    domain(_: Iterable<number>): this;
+
+    range(): number[];
+    range(_: Iterable<number>): this;
+
+    numberingOffset(): number;
+    numberingOffset(_: number): this;
+
+    padding(): number;
+    padding(_: number): this;
+
+    paddingInner(): number;
+    paddingInner(_: number): this;
+
+    paddingOuter(): number;
+    paddingOuter(_: number): this;
+
+    align(): number;
+    align(_: number): this;
+
+    step(): number;
+
+    bandwidth(): number;
+
+    ticks(count: number): number[];
+
+    tickFormat(count?: number, specifier?: string): (x: number) => string;
+
+    copy(): this;
+}