function#

class ansys.api.pyensight.ensight_api.function(session: Session)#

Class wrapper for EnSight function module

This class acts as a proxy for the EnSight Python module ensight.function

Methods

function.add_band_at_value(p0)

Function: add_band_at_value

function.add_bands_at_levels()

This command has not yet been documented.

function.add_bands_uniformly(p0)

Function: add_bands_uniformly

function.add_knot()

Function: add_knot

function.alpha_volume_scale(p0)

Function: alpha_volume_scale

function.band_add_type(p0)

This command has not yet been documented.

function.band_clear_all()

This command has not yet been documented.

function.band_clear_last()

This command has not yet been documented.

function.band_color(p0, p1, p2)

This command has not yet been documented.

function.band_number_items(p0)

This command has not yet been documented.

function.band_width(p0)

This command has not yet been documented.

function.begin()

Function: begin

function.color_space(p0)

Function: color_space

function.copy_palette(p0)

Function: copy_palette

function.copy_subpalette(p0, p1)

Function: copy_subpalette

function.create_palette()

Function: create_palette

function.create_subpalette()

Function: create_subpalette

function.degree(p0)

Function: degree

function.del_knot()

Function: del_knot

function.delete_full_palet(p0)

Function: delete_full_palet

function.delete_subpalette(p0, p1)

Function: delete_subpalette

function.description(p0)

Function: description

function.display_undefined(p0)

Selects how elements/nodes, at which variables are undefined, will be displayed.

function.edit_level(p0)

Sets the level in the palette for which value or color will be set/modified.

function.end()

Function: end

function.level()

Function: level

function.levels_lock(p0)

Function: levels_lock

function.limit_fringes(p0)

Selects how shaded elements above or below the min and max palette levels will be displayed.

function.modify_begin()

Groups function attribute commands together before applying them.

function.modify_end()

Groups function attribute commands together before applying them.

function.nlevels()

Function: nlevels

function.node_lock(p0)

Function: node_lock

function.number_of_colors(p0)

Function: #_of_colors

function.number_of_levels(p0)

Function: #_of_levels

function.over_time(p0, p1, p2)

Sets the option to include variable ranges over a time range on or off.

function.palette(p0)

Selects the palette that will be modified.

function.point()

Function: point

function.range(p0, p1)

Set the min and max range for a variable palette.

function.reset_range_time_chng(p0, p1, p2)

Function: reset_range_time_chng

function.restore(p0)

Restore a previously saved palette from a file.

function.restore_predefinedpal(*args, **kwargs)

Restores predefined palettes that are in the user's default palette directory.

function.rgb(p0, p1, p2)

Function: rgb

function.save(p0)

Save the palette for the currently selected variable.

function.save_all(p0)

Save all palettes to a file.

function.save_current_case(p0)

Save palettes, of active variables of the currently selected case, to a file.

function.scale(p0)

Sets the type of scale for value-separation of levels.

function.select_default()

Set palette selection to none, so that subsequent function attribute commands will apply to the default.

function.set_palette_to_minmax()

Set palette to the min/max of the variable.

function.set_palette_to_partminmax()

This command has not yet been documented.

function.set_palette_to_viewminmax()

This command has not yet been documented.

function.tie_to_var(p0)

Function: tie_to_var

function.type(p0)

Sets the type of color gradation that will be applied across elements.

function.undefined_color(p0, p1, p2)

Function: undefined_color

function.use_cont_for_elem_vars(p0, p1, p2)

Function: use_cont_for_elem_vars

function.use_subpal(p0)

Function: use_subpal

function.value(p0)

Sets the value to associate with a level in the palette.