Structs module

qe_api_client.structs.color(_color: str, index: int = -1)

qe_api_client.structs.color_map(colors: list = None, nul: dict = None, oth: dict = None, pal: str = None, single: dict = None, use_pal: bool = True, auto_fill: bool = True)

qe_api_client.structs.color_map_properties(dim_id: str, prop_def: dict = None, extends_id: str = '', state_name: str = '', _color_map: dict = None)

qe_api_client.structs.dim_coloring(change_hash: str = None, color_map_ref: str = '', has_value_colors: bool = False, base_color: dict = None)

qe_api_client.structs.dimension_list_def()

qe_api_client.structs.do_reload_ex_params(mode=0, partial=False, debug=False, reload_id='', skip_store=False, row_limit=0)

qe_api_client.structs.field_attributes(type: str = 'U', n_dec: int = 10, use_thou: int = 0, fmt: str = '', dec: str = '', thou: str = '')

qe_api_client.structs.field_list_def(show_system: bool = True, show_hidden: bool = True, show_derived_fields: bool = True, show_semantic: bool = True, show_src_tables: bool = True, show_implicit: bool = True)

qe_api_client.structs.field_value(text, is_numeric=False, number=0)

qe_api_client.structs.generic_dimension_properties(nx_info: dict, nx_library_dimension_def: dict, title: str, description: str = '', tags: list = None)

qe_api_client.structs.generic_measure_properties(nx_info: dict, nx_library_measure_def: dict, title: str, description: str = '', tags: list = None)

qe_api_client.structs.generic_object_properties(info: dict, prop_name: str, prop_def: dict = None, extends_id: str = '', state_name: str = '')

qe_api_client.structs.gradient(colors: list = None, break_types: list = None, limits: list = None, limit_type: str = 'percent')

qe_api_client.structs.hypercube_def(state_name: str = '', dimensions: list = None, measures: list = None, inter_column_sort_order: list = None, suppress_zero: bool = False, suppress_missing: bool = False, initial_data_fetch: list = None, reduction_mode: str = 'N', mode: str = 'S', pseudo_dim_pos: int = -1, no_of_left_dims: int = -1, always_fully_expanded: bool = False, max_stacked_cells: int = 5000, populate_missing: bool = False, show_totals_above: bool = False, indent_mode: bool = False, calc_cond: dict = None, sort_by_y_value: int = 0, title: dict = None, calc_condition: dict = None, column_order: list = None, expansion_state: list = None, dynamic_script: list = None, context_set_expression: str = '', suppress_measure_totals: bool = False, column_widths: list = None)

qe_api_client.structs.list_object_def(state_name: str = '$', library_id: str = '', definition: dict = None, auto_sort_by_state: dict = None, frequency_mode: str = 'N', show_alternatives: bool = False, initial_data_fetch: list = None, expressions: list = None, direct_query_simplified_view: bool = False, show_titles: bool = True, title: str = '', subtitle: str = '', footnote: str = '', disable_nav_menu: bool = False, show_details: bool = True, show_details_expression: bool = False, other_total_spec: dict = None)

qe_api_client.structs.measure_list_def()

qe_api_client.structs.mes_coloring(base_color: dict = None, _gradient: dict = None)

qe_api_client.structs.nx_attr_expr_def(expression: str = '', library_id: str = '', attribute: bool = True, num_format: dict = None, label: str = '', label_expression: str = '')

qe_api_client.structs.nx_calc_cond(cond: dict = None, msg: dict = None)

qe_api_client.structs.nx_dimension(library_id: str = '', dim_def: dict = None, null_suppression: bool = False, include_elem_value: bool = False, other_total_spec: dict = None, show_total: bool = False, show_all: bool = False, other_label: dict = None, total_label: dict = None, calc_cond: dict = None, attribute_expressions: list = None, attribute_dimensions: list = None, calc_condition: dict = None)

qe_api_client.structs.nx_get_bookmark_options(types: list, data: dict = None)

qe_api_client.structs.nx_info(obj_type, obj_id='')

Retrieves the data from a specific list object in a generic object.

Parameters:

• obj_type (str) – Type of the object. This parameter is mandatory.

• obj_id (str, optional) – Identifier of the object. If the chosen identifier is already in use, the engine automatically

• set (sets another one. If an identifier is not)

• optional. (the engine automatically sets one. This parameter is)

Returns:

Struct “nxInfo”

Return type:

dict

qe_api_client.structs.nx_inline_dimension_def(grouping: str = 'N', field_definitions: list = None, field_labels: list = None, sort_criterias: list = None, number_presentations: list = None, reverse_sort: bool = False, active_field: int = 0, label_expression: str = '', alias: str = '', auto_sort: bool = True, id=None, others_label: str = 'Others', _text_align: dict = None)

qe_api_client.structs.nx_inline_measure_def(label: str = '', description: str = '', tags: list = None, grouping='N', definition: str = '', num_format: dict = None, relative: bool = False, brutal_sum: bool = False, aggr_func: str = 'Expr', accumulate: int = 0, reverse_sort: bool = False, active_expression: int = 0, expressions: list = None, label_expression: str = '', auto_sort: bool = True, id=None, num_format_from_template: bool = True, _text_align: dict = None)

qe_api_client.structs.nx_library_dimension_def(grouping: str = 'N', field_definitions: list = None, field_labels: list = None, label_expression: str = '', alias: str = '', title: str = '', coloring: dict = None)

qe_api_client.structs.nx_library_measure_def(label: str, mes_def: str, grouping: str = 'N', expressions: list = None, active_expression: int = 0, label_expression: str = '', num_format: dict = None, coloring: dict = None)

qe_api_client.structs.nx_measure(library_id: str = '', mes_def: dict = None, sort_by: dict = None, attribute_expressions: list = None, attribute_dimensions: list = None, calc_cond: dict = None, calc_condition: dict = None, trend_lines: list = None)

qe_api_client.structs.nx_page(left: int = 0, top: int = 0, width: int = 50, height: int = 50)

qe_api_client.structs.nx_patch(op: str, path: str, value: str)

qe_api_client.structs.object_position_size(obj_id: str, obj_type: str, col: int, row: int, colspan: int, rowspan: int, y: float, x: float, width: float, height: float)

qe_api_client.structs.options(types: list, include_session_objects: bool = False, data: dict = None)

qe_api_client.structs.pivot_table_properties(info: dict, hypercube_def: dict, prop_def: dict = None, extends_id: str = '', state_name: str = '', _search: dict = None, show_titles: bool = True, title: str = '', subtitle: str = '', footnote: str = '', disable_nav_menu: bool = False, show_details: bool = True, show_details_expression: bool = False)

qe_api_client.structs.search(sorting: str = 'auto')

qe_api_client.structs.sheet_list_def()

qe_api_client.structs.slide_properties(extends_id: str = '', prop_def: dict = None, state_name: str = '')

qe_api_client.structs.slideitem_shape_properties(ratio: bool = True, position_top: str = '3.69985%', position_left: str = '31.25000%', position_width: str = '39.57903%', position_height: str = '11.28086%', position_z_index: int = 1, position_right: str = 'auto', visualization_type: str = '', style_color: str = '#000000')

qe_api_client.structs.slideitem_snapshot_properties(snapshot_id: str, visualization_type: str, ratio: bool = True, position_top: str = '14.81481%', position_left: str = '2.08333%', position_width: str = '95.83334%', position_height: str = '81.4814875%', position_z_index: int = 1)

qe_api_client.structs.slideitem_text_properties(ratio: bool = True, position_top: str = '3.69985%', position_left: str = '31.25000%', position_width: str = '39.57903%', position_height: str = '11.28086%', position_z_index: int = 1, position_right: str = 'auto', visualization_type: str = '', style_color: str = '#6E6E6E', style_text: str = '')

qe_api_client.structs.sn_pivot_table_properties(info: dict, hypercube_def: dict, prop_def: dict = None, extends_id: str = '', state_name: str = '', _search: dict = None, show_titles: bool = True, title: str = '', subtitle: str = '', footnote: str = '', disable_nav_menu: bool = False, show_details: bool = True, show_details_expression: bool = False, components: list = None, null_value_representation: dict = None)

qe_api_client.structs.sn_table_properties(info: dict, hypercube_def: dict, prop_def: dict = None, extends_id: str = '', state_name: str = '', show_titles: bool = True, title: str = '', subtitle: str = '', footnote: str = '', disable_nav_menu: bool = False, show_details: bool = False, show_details_expression: bool = False, components: list = None, _totals: dict = None, use_pagination: bool = False, enable_chart_exploration: bool = False, chart_exploration: dict = None)

qe_api_client.structs.sort_criteria(sort_by_state: int = 1, sort_by_frequency: int = 0, sort_by_numeric: int = 1, sort_by_ascii: int = 1, sort_by_load_order: int = 1, sort_by_load_expression: int = 0, expression=None, sort_by_load_greyness: int = 0)

qe_api_client.structs.static_content_url_def(url: str = None)

qe_api_client.structs.story_properties(title: str = '', description: str = '', extends_id: str = '', state_name: str = '', rank: int = 0, thumbnail_url: str = None)

qe_api_client.structs.string_expr(qv: str = '')

qe_api_client.structs.table_properties(info: dict, hypercube_def: dict, prop_def: dict = None, extends_id: str = '', state_name: str = '', script: str = '', _search: dict = None, show_titles: bool = True, title: str = '', subtitle: str = '', footnote: str = '', disable_nav_menu: bool = False, show_details: bool = False, show_details_expression: bool = False, _totals: dict = None, scrolling_horizontal: bool = True, scrolling_keep_first_column_in_view: bool = False, scrolling_keep_first_column_in_view_touch: bool = False, multiline_wrap_text_in_headers: bool = True, multiline_wrap_text_in_cells: bool = True)

qe_api_client.structs.text_align(auto: bool = True, align: str = 'left')

qe_api_client.structs.totals(totals_show: bool = True, totals_position: str = 'noTotals', totals_label: str = 'Totals')

qe_api_client.structs.value_color(value: str, color: str, index: int = -1)

qe_api_client.structs.value_expr(qv: str = '')

qe_api_client.structs.variable_list_def()