Method surface

tfjs-vis/src/visor.ts:137–161

* Creates a surface on the visor * * Most methods in tfjs-vis that take a surface also take a SurfaceInfo * so you rarely need to call this method unless you want to make a custom * plot. * * ```js * // Create a surface on a tab * tfvis.visor().surface({name: 'My Surface', ta

(options: SurfaceInfo)

   * @doc {heading: 'Visor & Surfaces', subheading: 'Visor Methods'}
   */
  surface(options: SurfaceInfo) {
    const {name} = options;
    const tab = options.tab == null ? DEFAULT_TAB : options.tab;

    if (name == null ||
        // tslint:disable-next-line
        !(typeof name === 'string' || name as any instanceof String)) {
      throw new Error(
          // tslint:disable-next-line
          'You must pass a config object with a \'name\' property to create or retrieve a surface');
    }

    const finalOptions: SurfaceInfoStrict = {
      ...options,
      tab,
    };

    const key = `${name}-${tab}`;
    if (!this.surfaceList.has(key)) {
      this.surfaceList.set(key, finalOptions);
    }

    this.renderVisor(this.el, this.surfaceList);
    return this.visorComponent.getSurface(name, tab);
  }

  /**
   * Returns a boolean indicating if the visor is in 'fullscreen' mode