IScriptMetrics

class

IScriptMetrics.

IScriptMetrics

Bases: object

Scripting API to build metrics table results.

get_all_metrics

Returns the available and valid metrics names.

Returns

The available metric queries

Return type

IList

full_metrics_table

contextNodeUri=None

Starts the full Code Analysis and returns the full metrics table.

Parameters

contextNodeUri (string) -- The context node uri

Returns

The metrics result table.

Return type

IMetricsTableResults

metrics_table

query_chain_names

contextNodeUri=None

Starts the full Code Analysis and returns the metrics table for requested query chains.

Parameters

  • query_chain_names (IEnumerable<string>) -- query chains to execute

  • contextNodeUri (string) -- The context node uri

Returns

The metrics result table

Return type

IMetricsTableResults