IDatabaseReportParams

class IDatabaseReportParams

Bases: ImpactCOMWrapperBase

Summary:

Report parameters that determine what data the report will show.

Remarks:

Introduced in Impact 6.4.0.9 and 7.0.0.58.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property check_config_only

Gets check_config_only.

Summary:

Indicates if the report will be executed in a mode that just check for a valid report configuration without processing any actual report data.

Remarks:

This mode can be used to validate a report configuration before it is saved.

Returns:

The value of check_config_only.

Return type:

check_config_only (bool)

property enable_advanced_features

Gets enable_advanced_features.

Summary:

Enable advanced features.

Remarks:

To maintain compatibility with earlier versions, the following properties are ignored unless enable_advanced_features is True: instance_guid, is_eof, page_number, sort_type, y_range_filter_condition Introduced in Impact 11.0.0.35

Returns:

The value of enable_advanced_features.

Return type:

enable_advanced_features (bool)

property error_code

Gets error_code.

Summary:

A code indicating the error (if any) in the report configuration.

Returns:

The value of error_code.

Return type:

error_code (ipDatabaseReportErrorCode)

property general_report_on

Gets general_report_on.

Summary:

The name of the table on which the general report will be generated.

Returns:

The value of general_report_on.

Return type:

general_report_on (str)

property include_added_layers

Gets include_added_layers.

Summary:

Indicates if added layers should be included in the report.

Remarks:

Applies only to a layer report.

Returns:

The value of include_added_layers.

Return type:

include_added_layers (bool)

property include_deleted_layers

Gets include_deleted_layers.

Summary:

Indicates if deleted layers should be included in the report.

Remarks:

Applies only to a layer report.

Returns:

The value of include_deleted_layers.

Return type:

include_deleted_layers (bool)

property include_empty_bands

Gets include_empty_bands.

Summary:

Indicates if empty bands should be included.

Remarks:

When the x-axis is banded, some bands may contain no y-axis information. Including such empty bands may be desirable to give a more complete picture of the data, but may cause the x-axis to contain more data than can be displayed by the client.

Returns:

The value of include_empty_bands.

Return type:

include_empty_bands (bool)

property include_x_axis_nulls

Gets include_x_axis_nulls.

Summary:

Indicates if the NULL value should be included on the x-axis.

Remarks:

The x-axis column data may legitimately contain NULL values. This option allows these to be included.

Returns:

The value of include_x_axis_nulls.

Return type:

include_x_axis_nulls (bool)

property instance_guid

Gets instance_guid.

Summary:

Instance GUID

Remarks:

Providing this GUID allows Impact to cache report items and provide them in pages on subsequent requests. Introduced in Impact 11.0.0.35

Returns:

The value of instance_guid.

Return type:

instance_guid (str)

property is_eof

Gets is_eof.

Summary:

Indicates when there is no more data

Remarks:

Introduced in Impact 11.0.0.35

Returns:

The value of is_eof.

Return type:

is_eof (bool)

property max_x_axis_items

Gets max_x_axis_items.

Summary:

The maximum number of values to return for the x-axis.

Returns:

The value of max_x_axis_items.

Return type:

max_x_axis_items (int)

property max_x_axis_items_exceeded

Gets max_x_axis_items_exceeded.

Summary:

Indicates if the number of values on the x-axis has been capped to max_x_axis_items

Returns:

The value of max_x_axis_items_exceeded.

Return type:

max_x_axis_items_exceeded (bool)

property numeric_x_axis_bandwidth

Gets numeric_x_axis_bandwidth.

Summary:

The width of each x-axis band when it is displaying numeric data.

Remarks:

Applies only when x_axis_banding is xbNumericBands.

Returns:

The value of numeric_x_axis_bandwidth.

Return type:

numeric_x_axis_bandwidth (int)

property page_number

Gets page_number.

Summary:

Represents the page number in a paged report where page size is specified by max_x_axis_items.

Remarks:

Introduced in Impact 11.0.0.35

Returns:

The value of page_number.

Return type:

page_number (int)

property server_time_zone_id

Gets server_time_zone_id.

Summary:

An ID indicating the server’s timezone.

Remarks:

This may be required when displaying date/time information on the x-axis if the user is working in a different timezone to the server.

Returns:

The value of server_time_zone_id.

Return type:

server_time_zone_id (str)

property sort_type

Gets sort_type.

Summary:

Report sort type.

Remarks:

Introduced in Impact 11.0.0.35

Returns:

The value of sort_type.

Return type:

sort_type (ipReportSortType)

property unit_settings

Gets unit_settings.

Summary:

The unit settings to use when formatting numeric values.

Returns:

The value of unit_settings.

Return type:

unit_settings (IUnitSettings)

property user_time_zone_id

Gets user_time_zone_id.

Summary:

An ID indicating the server’s timezone.

Remarks:

This may be required when displaying date/time information on the x-axis if the user is working in a different timezone to the server.

Returns:

The value of user_time_zone_id.

Return type:

user_time_zone_id (str)

property x_axis_banding

Gets x_axis_banding.

Summary:

The type of banding to use on the x-axis.

Returns:

The value of x_axis_banding.

Return type:

x_axis_banding (ipDatabaseReportXAxisBanding)

property x_axis_column_name

Gets x_axis_column_name.

Summary:

The name of the column to use for the x-axis.

Returns:

The value of x_axis_column_name.

Return type:

x_axis_column_name (str)

property x_axis_lookup_key_column_name

Gets x_axis_lookup_key_column_name.

Summary:

The name of the key column in the lookup table.

Remarks:

When the x-axis displays data that is looked up from another table, this is the name of the key column in that table.

Returns:

The value of x_axis_lookup_key_column_name.

Return type:

x_axis_lookup_key_column_name (str)

property x_axis_lookup_result_column_name

Gets x_axis_lookup_result_column_name.

Summary:

The name of the result column in the lookup table.

Remarks:

When the x-axis displays data that is looked up from another table, this is the name of the result column in that table (ie the column that contains the data looke up by the given key).

Returns:

The value of x_axis_lookup_result_column_name.

Return type:

x_axis_lookup_result_column_name (str)

property y_axis_column_name

Gets y_axis_column_name.

Summary:

The name of the column to use for the y-axis.

Returns:

The value of y_axis_column_name.

Return type:

y_axis_column_name (str)

property y_axis_function

Gets y_axis_function.

Summary:

The function to apply to y-axis data.

Returns:

The value of y_axis_function.

Return type:

y_axis_function (ipDatabaseReportYAxisFunction)

property y_range_filter_condition

Gets y_range_filter_condition.

Summary:

Specifies the filter to apply to y values. Null value means there is no filter in y.

Remarks:

Introduced in Impact 11.0.0.35

Returns:

The value of y_range_filter_condition.

Return type:

y_range_filter_condition (ISQLFilterCondition)

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

use_relationship_lookup(value)

Summary:

Use the specified database table relationship.

Remarks:

Introduced in Impact 11.0.0.80

Parameters:

value (str) – A string representing the database table relationship.