IBorderPlotCreator¶
- class IBorderPlotCreator¶
Bases:
ImpactCOMWrapperBase- Description:
Use the IBorderPlotCreator for creating reports (originally known as border plots).
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property destination_drawing¶
Gets destination_drawing.
- Description:
Gets the destination drawing of the border plot.
- Remarks:
If the border plot created a new layer in an existing project or created a new project then this property returns the drawing. If the border plot created a temporary drawing and output it then it is not possible to retrieve the drawing because it has been destroyed.
- Returns:
The value of destination_drawing.
- Return type:
- property display_dialog¶
Gets display_dialog.
- Description:
Displays the Border Plot Select dialog when the Create method is called.
- Remarks:
Setting this property from IServer will result in an error.
- Returns:
The value of display_dialog.
- Return type:
display_dialog (bool)
- property export_file_name¶
Gets export_file_name.
- Description:
Gets or sets the export file name when exporting.
- Remarks:
When the border plot is being output directly to an export file you can specify the file name. If no file name is specified then the user will be prompted for the file name, this does not apply for the IServer.
- Returns:
The value of export_file_name.
- Return type:
export_file_name (str)
- property pages¶
Gets Pages.
- Description:
Returns an IBorderPlotPages collection representing the pages in the border plot settings.
- Remarks:
This property can only be accessed once the Settings have been assigned.
- Returns:
The value of Pages.
- Return type:
- property print_options¶
Gets print_options.
- Description:
Gets the IPrintOptions to use when outputting to a printer.
- Remarks:
When the border plot is being output directly to a printer you can override additional printer options using the IPrintOptions object.
- Returns:
The value of print_options.
- Return type:
- property settings¶
Gets Settings.
- Description:
The border plot settings to use.
- Remarks:
Setting the border plot settings loads the defined Pages within the border plot settings. If a source_drawing has been assigned then the IBorderPlotCreator automatically assigns layers to all border plot areas within each defined page using auto_match_layers. If you don’t want this automatching to occur then set the Settings property before the source_drawing property. You can then manually set the assigned Layers to each border plot area in a Page if required.
- Returns:
The value of Settings.
- Return type:
- property source_database_item¶
Gets source_database_item.
- Description:
The source database item for the border plot.
- Remarks:
Only one of source_drawing, source_database_item, source_database_layer, source_database_revision may be used at any time. Setting one property will clear the others. Introduced in Impact 8.0.0.19
- Returns:
The value of source_database_item.
- Return type:
- property source_database_layer¶
Gets source_database_layer.
- Description:
The source database layer for the border plot.
- Remarks:
Only one of source_drawing, source_database_item, source_database_layer, source_database_revision may be used at any time. Setting one property will clear the others. Introduced in Impact 8.0.0.91.
- Returns:
The value of source_database_layer.
- Return type:
- property source_database_revision¶
Gets source_database_revision.
- Description:
The source revision for the border plot.
- Remarks:
Only one of source_drawing, source_database_item, source_database_layer, source_database_revision may be used at any time. Setting one property will clear the others. Introduced in Impact 8.0.0.19
- Returns:
The value of source_database_revision.
- Return type:
- property source_drawing¶
Gets source_drawing.
- Description:
The source drawing for the border plot.
- Remarks:
Normally you should assign the source_drawing before assigning the Settings, see Settings for details. Only one of source_drawing, source_database_item, source_database_layer, source_database_revision may be used at any time. Setting one property will clear the others.
- Returns:
The value of source_drawing.
- Return type:
- property starting_page_number¶
Gets starting_page_number.
- Description:
Gets or sets the starting page number
- Remarks:
introduced in Impact 11.1.0.6 and 12.0.0.67
- Returns:
The value of starting_page_number.
- Return type:
starting_page_number (int)
- property total_pages_generated¶
Gets total_pages_generated.
- Description:
Gets the total pages generated
- Remarks:
introduced in Impact 11.1.0.6 and 12.0.0.67
- Returns:
The value of total_pages_generated.
- Return type:
total_pages_generated (int)
- property valid¶
Gets Valid.
- Description:
Indicates whether the properties of IBorderPlotCreator are valid and the Create method can be called.
- Remarks:
Any border plot areas that don’t have an assigned layer are automatically matched if possible using auto_match_layers. This following checks are also performed A valid source_drawing has been assigned A valid Settings have been assigned If display_dialog is false that all border plot areas have valid layers assigned to them, For IServer an export_file_name has been specified if outputting to an export file.
- Returns:
The value of Valid.
- Return type:
valid (bool)
- auto_match_layers()¶
- Description:
Indicates whether layers will be automatically matched to border plot areas.
- Remarks:
Each border plot settings specifies one or more pages; each page contains zero or more border plot areas. This method uses the layer matching rules defined in the settings to determine which layers contained in the source_drawing can be automatically matched to each border plot area. To explicitly match layers to areas, use the IBorderPlotAreas collection of each page within the IBorderPlotPages collection.
- create()¶
- Description:
Creates the border plot(s) using the defined properties.
- Remarks:
If the properties are Valid then the border plot(s) are produced. The result can be used to determine if a border plot was produced or not. To retrieve the created border plot drawing use the destination_drawing property.