pyvista.DataSetMapper

class DataSetMapper(*args, **kwargs)

Wrap vtkDataSetMapper.

Parameters:

datasetpyvista.DataSet, optional

Dataset to assign to this mapper.

themepyvista.plotting.themes.Theme, optional

Plot-specific theme.

Examples

Create a mapper outside pyvista.Plotter and assign it to an actor.

>>> import pyvista as pv
>>> mesh = pv.Cube()
>>> mapper = pv.DataSetMapper(dataset=mesh)
>>> actor = pv.Actor(mapper=mapper)
>>> actor.plot()

Static Scene

Interactive Scene

Methods

Attributes

DataSetMapper.abort_execute	read-write, calls GetAbortExecute/SetAbortExecute
DataSetMapper.abort_output	read-write, calls GetAbortOutput/SetAbortOutput
DataSetMapper.array_access_mode	read-write, calls GetArrayAccessMode/SetArrayAccessMode
DataSetMapper.array_component	read-write, calls GetArrayComponent/SetArrayComponent
DataSetMapper.array_id	read-write, calls GetArrayId/SetArrayId
DataSetMapper.array_name	Return or set the array name or number and component to color by.
DataSetMapper.bounds	Return the bounds of this mapper.
DataSetMapper.bounds_size	Return the size of each axis of the object's bounding box.
DataSetMapper.center	Return the center of mapper.
DataSetMapper.class_name	read-only, calls GetClassName
DataSetMapper.clipping_planes	read-write, calls GetClippingPlanes/SetClippingPlanes
DataSetMapper.cmap	Colormap assigned to this mapper.
DataSetMapper.color_coordinates	read-only, calls GetColorCoordinates
DataSetMapper.color_map_colors	read-only, calls GetColorMapColors
DataSetMapper.color_mode	Return or set the color mode.
DataSetMapper.color_texture_map	read-only, calls GetColorTextureMap
DataSetMapper.container_algorithm	read-write, calls GetContainerAlgorithm/SetContainerAlgorithm
DataSetMapper.data_set_input	read-only, calls GetDataSetInput
DataSetMapper.dataset	Return or set the dataset assigned to this mapper.
DataSetMapper.debug	read-write, calls GetDebug/SetDebug
DataSetMapper.default_executive_prototype	write-only, calls SetDefaultExecutivePrototype
DataSetMapper.error_code	read-only, calls GetErrorCode
DataSetMapper.executive	read-write, calls GetExecutive/SetExecutive
DataSetMapper.field_data_tuple_id	read-write, calls GetFieldDataTupleId/SetFieldDataTupleId
DataSetMapper.global_warning_display	read-write, calls GetGlobalWarningDisplay/SetGlobalWarningDisplay
DataSetMapper.information	read-write, calls GetInformation/SetInformation
DataSetMapper.input	read-only, calls GetInput
DataSetMapper.input_algorithm	read-only, calls GetInputAlgorithm
DataSetMapper.input_array_to_process	write-only, calls SetInputArrayToProcess
DataSetMapper.input_as_data_set	read-only, calls GetInputAsDataSet
DataSetMapper.input_connection	write-only, calls SetInputConnection
DataSetMapper.input_data	write-only, calls SetInputData
DataSetMapper.input_data_object	write-only, calls SetInputDataObject
DataSetMapper.input_executive	read-only, calls GetInputExecutive
DataSetMapper.input_information	read-only, calls GetInputInformation
DataSetMapper.interpolate_before_map	Return or set the interpolation of scalars before mapping.
DataSetMapper.interpolate_scalars_before_mapping	read-write, calls GetInterpolateScalarsBeforeMapping/SetInterpolateScalarsBeforeMapping
DataSetMapper.is_in_memkind	read-only, calls GetIsInMemkind
DataSetMapper.length	read-only, calls GetLength
DataSetMapper.lookup_table	Return or set the lookup table.
DataSetMapper.m_time	read-only, calls GetMTime
DataSetMapper.memkind_directory	write-only, calls SetMemkindDirectory
DataSetMapper.no_prior_temporal_access_information_key	write-only, calls SetNoPriorTemporalAccessInformationKey
DataSetMapper.number_of_clipping_planes	read-only, calls GetNumberOfClippingPlanes
DataSetMapper.number_of_input_array_specifications	read-only, calls GetNumberOfInputArraySpecifications
DataSetMapper.number_of_input_ports	read-only, calls GetNumberOfInputPorts
DataSetMapper.number_of_output_ports	read-only, calls GetNumberOfOutputPorts
DataSetMapper.object_description	read-only, calls GetObjectDescription
DataSetMapper.object_name	read-write, calls GetObjectName/SetObjectName
DataSetMapper.output_port	read-only, calls GetOutputPort
DataSetMapper.poly_data_mapper	read-only, calls GetPolyDataMapper
DataSetMapper.progress	read-only, calls GetProgress
DataSetMapper.progress_observer	read-write, calls GetProgressObserver/SetProgressObserver
DataSetMapper.progress_scale	read-only, calls GetProgressScale
DataSetMapper.progress_shift	read-only, calls GetProgressShift
DataSetMapper.progress_shift_scale	write-only, calls SetProgressShiftScale
DataSetMapper.progress_text	read-write, calls GetProgressText/SetProgressText
DataSetMapper.reference_count	read-write, calls GetReferenceCount/SetReferenceCount
DataSetMapper.relative_coincident_topology_line_offset_parameters	write-only, calls SetRelativeCoincidentTopologyLineOffsetParameters
DataSetMapper.relative_coincident_topology_point_offset_parameter	write-only, calls SetRelativeCoincidentTopologyPointOffsetParameter
DataSetMapper.relative_coincident_topology_polygon_offset_parameters	write-only, calls SetRelativeCoincidentTopologyPolygonOffsetParameters
DataSetMapper.release_data_flag	read-write, calls GetReleaseDataFlag/SetReleaseDataFlag
DataSetMapper.render_time	read-write, calls GetRenderTime/SetRenderTime
DataSetMapper.resolve	Set or return the global flag to avoid z-buffer resolution.
DataSetMapper.resolve_coincident_topology	read-write, calls GetResolveCoincidentTopology/SetResolveCoincidentTopology
DataSetMapper.resolve_coincident_topology_line_offset_parameters	write-only, calls SetResolveCoincidentTopologyLineOffsetParameters
DataSetMapper.resolve_coincident_topology_point_offset_parameter	write-only, calls SetResolveCoincidentTopologyPointOffsetParameter
DataSetMapper.resolve_coincident_topology_polygon_offset_faces	read-write, calls GetResolveCoincidentTopologyPolygonOffsetFaces/SetResolveCoincidentTopologyPolygonOffsetFaces
DataSetMapper.resolve_coincident_topology_polygon_offset_parameters	write-only, calls SetResolveCoincidentTopologyPolygonOffsetParameters
DataSetMapper.resolve_coincident_topology_to_off	write-only, calls SetResolveCoincidentTopologyToOff
DataSetMapper.resolve_coincident_topology_z_shift	read-write, calls GetResolveCoincidentTopologyZShift/SetResolveCoincidentTopologyZShift
DataSetMapper.scalar_map_mode	Return or set the scalar map mode.
DataSetMapper.scalar_mode	read-write, calls GetScalarMode/SetScalarMode
DataSetMapper.scalar_range	Return or set the scalar range.
DataSetMapper.scalar_visibility	Return or set the scalar visibility.
DataSetMapper.selection	read-write, calls GetSelection/SetSelection
DataSetMapper.static	read-write, calls GetStatic/SetStatic
DataSetMapper.supports_selection	read-only, calls GetSupportsSelection
DataSetMapper.time_to_draw	read-only, calls GetTimeToDraw
DataSetMapper.total_number_of_input_connections	read-only, calls GetTotalNumberOfInputConnections
DataSetMapper.update_extent	read-only, calls GetUpdateExtent
DataSetMapper.update_ghost_level	read-only, calls GetUpdateGhostLevel
DataSetMapper.update_number_of_pieces	read-only, calls GetUpdateNumberOfPieces
DataSetMapper.update_piece	read-only, calls GetUpdatePiece
DataSetMapper.use_lookup_table_scalar_range	read-write, calls GetUseLookupTableScalarRange/SetUseLookupTableScalarRange
DataSetMapper.using_memkind	read-only, calls GetUsingMemkind