revitron.roomtag¶
A simple helper module for creating room tags.
Classes:
|
This class contains methods to create room tags in given locations. |
- class RoomTag[source]¶
Bases:
object
This class contains methods to create room tags in given locations.
Methods:
bottomLeft
(room[, tagTypeId, viewId])Create a room tag in the bottom left corner.
bottomRight
(room[, tagTypeId, viewId])Create a room tag in the bottom right corner.
center
(room[, tagTypeId, viewId])Create a room tag in the bounding box center.
create
(room, location[, tagTypeId, viewId])Create a room tag in a given location.
topLeft
(room[, tagTypeId, viewId])Create a room tag in the top left corner.
topRight
(room[, tagTypeId, viewId])Create a room tag in the top right corner.
- static bottomLeft(room, tagTypeId=False, viewId=False)[source]¶
Create a room tag in the bottom left corner.
All existing room tags will be removed before automatically.
- Parameters
room (object) – A Revit room element.
tagTypeId (ElementId, optional) – A Revit element Id of a custom tag type. Defaults to False.
viewId (ElementId, optional) – A Revit element Id a view. Defaults to False.
- Returns
A Revit
RoomTag
element- Return type
object
- static bottomRight(room, tagTypeId=False, viewId=False)[source]¶
Create a room tag in the bottom right corner.
All existing room tags will be removed before automatically.
- Parameters
room (object) – A Revit room element.
tagTypeId (ElementId, optional) – A Revit element Id of a custom tag type. Defaults to False.
viewId (ElementId, optional) – A Revit element Id a view. Defaults to False.
- Returns
A Revit
RoomTag
element- Return type
object
- static center(room, tagTypeId=False, viewId=False)[source]¶
Create a room tag in the bounding box center.
All existing room tags will be removed before automatically.
- Parameters
room (object) – A Revit room element.
tagTypeId (ElementId, optional) – A Revit element Id of a custom tag type. Defaults to False.
viewId (ElementId, optional) – A Revit element Id a view. Defaults to False.
- Returns
A Revit
RoomTag
element- Return type
object
- static create(room, location, tagTypeId=False, viewId=False)[source]¶
Create a room tag in a given location.
All existing room tags will be removed before automatically.
- Parameters
location (object) – A Revit location point object.
tagTypeId (ElementId, optional) – A Revit element Id of a custom tag type. Defaults to False.
viewId (ElementId, optional) – A Revit element Id a view. Defaults to False.
- Returns
A Revit
RoomTag
element- Return type
object
- static topLeft(room, tagTypeId=False, viewId=False)[source]¶
Create a room tag in the top left corner.
All existing room tags will be removed before automatically.
- Parameters
room (object) – A Revit room element.
tagTypeId (ElementId, optional) – A Revit element Id of a custom tag type. Defaults to False.
viewId (ElementId, optional) – A Revit element Id a view. Defaults to False.
- Returns
A Revit
RoomTag
element- Return type
object
- static topRight(room, tagTypeId=False, viewId=False)[source]¶
Create a room tag in the top right corner.
All existing room tags will be removed before automatically.
- Parameters
room (object) – A Revit room element.
tagTypeId (ElementId, optional) – A Revit element Id of a custom tag type. Defaults to False.
viewId (ElementId, optional) – A Revit element Id a view. Defaults to False.
- Returns
A Revit
RoomTag
element- Return type
object