DoAssessmentOptions

DoAssessmentOptions

Class to hold options that can be passed to the ProtocolAssessment.DoOccupantAssessment and ProtocolAssessment.DoStructureAssessment functions

Constructor

new DoAssessmentOptions(graph_layout, first_graph_id, first_page_id, blank_all, remove_existing_graphs, output_diropt)

Source:
Parameters:
Name Type Attributes Default Description
graph_layout string Graph layout
first_graph_id number First graph ID to use when plotting results
first_page_id number First page ID to use when plotting results
blank_all boolean Switch whether to blank all existing curves and datums before plotting results
remove_existing_graphs boolean Switch whether to remove existing graphs from a page
output_dir string <optional>
"" Output directory for "reporter" images

Members

(static) GRAPH_LAYOUT_REPORTER :string

Description:
  • Reporter graph layout option
Source:
Reporter graph layout option
Type:
  • string

(static) GRAPH_LAYOUT_SAME_PAGE :string

Description:
  • same page graph layout option
Source:
same page graph layout option
Type:
  • string

(static) GRAPH_LAYOUT_SEPARATE_PAGES :string

Description:
  • Separate pages graph layout option
Source:
Separate pages graph layout option
Type:
  • string

blank_all :boolean

Description:
  • Switch whether to blank all existing curves and datums before plotting results
Source:
Switch whether to blank all existing curves and datums before plotting results
Type:
  • boolean

first_graph_id :number

Description:
  • First graph ID to use when plotting results
Source:
First graph ID to use when plotting results
Type:
  • number

first_page_id :number

Description:
  • First page ID to use when plotting results
Source:
First page ID to use when plotting results
Type:
  • number

graph_layout :string

Description:
  • Graph layout
Source:
Graph layout
Type:
  • string

output_dir :string

Description:
  • Output directory
Source:
Output directory
Type:
  • string

remove_existing_graphs :boolean

Description:
  • Switch whether to remove existing graphs from a page
Source:
Switch whether to remove existing graphs from a page
Type:
  • boolean

Methods

(static) GraphLayouts() → {Array.<string>}

Description:
  • Return a list of valid graph layouts
Source:
Returns:
Type
Array.<string>