Class Visualization

Creates, launches, and allows updating a CBRV visualization.

Hierarchy

Visualization

Index

Constructors

Properties

codebase VisualizationState

Accessors

active viewColumn visible

Methods

dispose getLine getRelativePath launch onFilesChange reveal update

Constructors

constructor

new Visualization(context: ExtensionContext, codebase: Uri, settings?: VisualizationSettings): Visualization
Construct a Visualization. You shouldn't call this directly, instead use create
Parameters
- context: ExtensionContext
- codebase: Uri
- settings: VisualizationSettings = {}
Returns Visualization
- Defined in src/Visualization.ts:306

Properties

`Readonly` codebase

codebase: Uri

The URI of the root of the codebase this Visualization is visualizing.

`Static` VisualizationState

VisualizationState: typeof __class = ...

A mutable "view" on a Visualization

Accessors

active

get active(): boolean
These properties and methods are just passed through to the internal webview panel. See https://code.visualstudio.com/api/references/vscode-api#WebviewPanel

Returns boolean
- Defined in src/Visualization.ts:398

viewColumn

get viewColumn(): undefined | ViewColumn
Returns undefined | ViewColumn
- Defined in src/Visualization.ts:399

visible

get visible(): boolean
Returns boolean
- Defined in src/Visualization.ts:400

Methods

dispose

dispose(): void
Destroy the visualization and all webviews/watchers etc.

Returns void
- Defined in src/Visualization.ts:483

getLine

getLine(end: undefined | Endpoint): undefined | number
Takes a endpoint of a connection and returns the line number, if there is one.
Parameters
- end: undefined | Endpoint
Returns undefined | number
- Defined in src/Visualization.ts:495

getRelativePath

getRelativePath(end: undefined | Endpoint): undefined | string
Takes an endpoint of a connection and returns the path relative to the codebase
Parameters
- end: undefined | Endpoint
Returns undefined | string
- Defined in src/Visualization.ts:489

launch

launch(): Promise<void>
Open up the visualizing in the webview. You shouldn't call this directly, API.create launches automatically.

Returns Promise<void>
- Defined in src/Visualization.ts:409

onFilesChange

onFilesChange(func: ((visState: __class) => Promise<void>), options?: {
immediate?: boolean;
}): void
Set the callback to update the visualization whenever the filelist change. It will trigger if a file is created, modified, or deleted, or if the filters change. Most the time, you'll want to use this instead of using update directly.

You can pass {immediate: true} if you want it to trigger immediately as well.
Parameters
- func: ((visState: __class) => Promise<void>)
  - - (visState: __class): Promise<void>
    - Parameters
      
      visState: __class
      
      Returns Promise<void>
- Optional options: {
  immediate?: boolean;
  }
  - Optional immediate?: boolean
Returns void
- Defined in src/Visualization.ts:386

reveal

reveal(viewColumn?: ViewColumn, preserveFocus?: boolean): void
Parameters
- Optional viewColumn: ViewColumn
- Optional preserveFocus: boolean
Returns void
- Defined in src/Visualization.ts:401

update

update(func: ((visState: __class) => Promise<void>)): Promise<void>
Used to update the visualization. Update the state in the callback and the visualization will update after calling the callback.
Parameters
- func: ((visState: __class) => Promise<void>)
  - - (visState: __class): Promise<void>
    - Parameters
      
      visState: __class
      
      Returns Promise<void>
Returns Promise<void>
- Defined in src/Visualization.ts:355

Generated using TypeDoc