SpaceSpreadsheet(Space)
base classes — bpy_struct
, Space
- class bpy.types.SpaceSpreadsheet(Space)
Spreadsheet space data
- attribute_domain
Attribute domain to display
POINT
Point – Attribute on point.EDGE
Edge – Attribute on mesh edge.FACE
Face – Attribute on mesh faces.CORNER
Face Corner – Attribute on mesh face corner.CURVE
Spline – Attribute on spline.INSTANCE
Instance – Attribute on instance.
- Type
enum in [‘POINT’, ‘EDGE’, ‘FACE’, ‘CORNER’, ‘CURVE’, ‘INSTANCE’], default ‘POINT’
- columns
Persistent data associated with spreadsheet columns
- Type
bpy_prop_collection
ofSpreadsheetColumn
, (readonly)
- context_path
Context path to the data being displayed
- Type
SpreadsheetContextPath
bpy_prop_collection
ofSpreadsheetContext
, (readonly)
- display_context_path_collapsed
- Type
boolean, default False
- geometry_component_type
Part of the geometry to display data from
MESH
Mesh – Mesh component containing point, corner, edge and face data.POINTCLOUD
Point Cloud – Point cloud component containing only point data.CURVE
Curve – Curve component containing spline and control point data.INSTANCES
Instances – Instances of objects or collections.
- Type
enum in [‘MESH’, ‘POINTCLOUD’, ‘CURVE’, ‘INSTANCES’], default ‘MESH’
- is_pinned
Context path is pinned
- Type
boolean, default False
- object_eval_state
EVALUATED
Evaluated – Use data from fully or partially evaluated object.ORIGINAL
Original – Use data from original object without any modifiers applied.VIEWER_NODE
Viewer Node – Use intermediate data from viewer node.
- Type
enum in [‘EVALUATED’, ‘ORIGINAL’, ‘VIEWER_NODE’], default ‘EVALUATED’
- row_filters
Filters to remove rows from the displayed data
- Type
bpy_prop_collection
ofSpreadsheetRowFilter
, (readonly)
- show_only_selected
Only include rows that correspond to selected elements
- Type
boolean, default False
- show_region_channels
- Type
boolean, default False
- Type
boolean, default False
- show_region_ui
- Type
boolean, default False
- use_filter
- Type
boolean, default False
- classmethod bl_rna_get_subclass(id, default=None)
- Parameters
id (string) – The RNA type identifier.
- Returns
The RNA type or default when not found.
- Return type
bpy.types.Struct
subclass
- classmethod bl_rna_get_subclass_py(id, default=None)
- Parameters
id (string) – The RNA type identifier.
- Returns
The class or default when not found.
- Return type
type
- draw_handler_add(callback, args, region_type, draw_type)
Add a new draw handler to this space type. It will be called every time the specified region in the space type will be drawn. Note: All arguments are positional only for now.
- Parameters
callback (function) – A function that will be called when the region is drawn. It gets the specified arguments as input.
args (tuple) – Arguments that will be passed to the callback.
region_type (str) – The region type the callback draws in; usually
WINDOW
. (bpy.types.Region.type
)draw_type (str) – Usually
POST_PIXEL
for 2D drawing andPOST_VIEW
for 3D drawing. In some casesPRE_VIEW
can be used.BACKDROP
can be used for backdrops in the node editor.
- Returns
Handler that can be removed later on.
- Return type
object
- draw_handler_remove(handler, region_type)
Remove a draw handler that was added previously.
- Parameters
handler (object) – The draw handler that should be removed.
region_type (str) – Region type the callback was added to.
Inherited Properties
Inherited Functions