Skip to content

Commit

Permalink
Set08| Add Node Documentation for...(Documentation Added: 20 nodes) (#…
Browse files Browse the repository at this point in the history
…3098)

* Dynamo.Nodes.DSUvOnElementSelection

* DSRevitNodesUI.DetailLevel

* Revit.Elements.Parameter.SharedParameterFile

* Revit.Elements.Parameter.CreateSharedParameterForAllCategories

* Revit.Elements.Parameter.CreateSharedParameter

* Revit.Elements.GlobalParameter.FindByName

* Revit.Elements.GlobalParameter.Value

* Revit.Elements.FamilyParameter.IsReadOnly

* Revit.Elements.FamilyParameter.IsShared

* Revit.Elements.FamilyParameter.Id

* Revit.Elements.FamilyParameter.Name

* Revit.Elements.FamilyParameter.Unit

* Revit.Elements.FamilyParameter.CanAssignFormula

* Revit.Elements.FamilyParameter.IsReporting

* Revit.Elements.GlobalParameter.Name

* Revit.Elements.GlobalParameter.Visible

* Revit.Elements.GlobalParameter.SpecType

* Revit.Elements.GlobalParameter.GroupType

* Revit.Elements.GlobalParameter.SetValue

* Revit.Elements.GlobalParameter.ByName

* Update DSRevitNodesUI.DetailLevel.md

* Update Revit.Elements.FamilyParameter.Id.md

* Update Revit.Elements.GlobalParameter.GroupType.md

* Update Revit.Elements.Parameter.CreateSharedParameter.md

* Move from Review
  • Loading branch information
johnpierson authored Oct 9, 2024
1 parent d39370c commit 9982a93
Show file tree
Hide file tree
Showing 60 changed files with 5,057 additions and 42 deletions.
256 changes: 256 additions & 0 deletions doc/distrib/NodeHelpFiles/DSRevitNodesUI.DetailLevel.dyn
Original file line number Diff line number Diff line change
@@ -0,0 +1,256 @@
{
"Uuid": "2bbdb10f-7e71-44b6-8cf3-99fff16c878e",
"IsCustomNode": false,
"Description": "",
"Name": "DSRevitNodesUI.DetailLevel",
"ElementResolver": {
"ResolutionMap": {}
},
"Inputs": [],
"Outputs": [],
"Nodes": [
{
"ConcreteType": "DSRevitNodesUI.DetailLevel, DSRevitNodesUI",
"SelectedIndex": 0,
"SelectedString": "Coarse",
"Id": "bc3de6454869447ca4b20524e1ecd92a",
"NodeType": "ExtensionNode",
"Inputs": [],
"Outputs": [
{
"Id": "f85bdd071c954afcacc85a75c6d16e68",
"Name": "detailLevel",
"Description": "The selected detailLevel",
"UsingDefaultValue": false,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
}
],
"Replication": "Disabled",
"Description": "Enables selection of a detail level for all Revit elements, families, and views"
},
{
"ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
"Id": "aea14b09eeca4137bb5028813db62e8e",
"NodeType": "FunctionNode",
"Inputs": [
{
"Id": "71448612acc749e89ee3d34af234b0a1",
"Name": "cutFillColor",
"Description": "Fill color\n\nColor\nDefault value : null",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "4e964b1266cf4f9398f9db85d8e96a14",
"Name": "projectionFillColor",
"Description": "Projection color\n\nColor\nDefault value : null",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "2a1e393aa92e4d02a57abb3e5bba6584",
"Name": "cutLineColor",
"Description": "Cut line color\n\nColor\nDefault value : null",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "64a04328c95a45f68952582ed004c301",
"Name": "projectionLineColor",
"Description": "Projection line color\n\nColor\nDefault value : null",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "f2fac6cc84e244828b5d7df86af6af5a",
"Name": "cutFillPattern",
"Description": "Cut fill pattern\n\nFillPatternElement\nDefault value : null",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "26f4c158e667453db595d66045e1af1c",
"Name": "projectionFillPattern",
"Description": "Projection fill pattern\n\nFillPatternElement\nDefault value : null",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "fb9ab9ba3e714902a7b807df2eb20357",
"Name": "cutLinePattern",
"Description": "Cut line pattern\n\nLinePatternElement\nDefault value : null",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "9ed16eb900c64f43b7c8ba8edba978bf",
"Name": "projectionLinePattern",
"Description": "Projection line pattern\n\nLinePatternElement\nDefault value : null",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "27044e740ac041029d7f3c288bd461a8",
"Name": "cutLineWeight",
"Description": "Cut line weight\n\nint\nDefault value : -1",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "f8042baf4cfc41b2a76f0335871e9747",
"Name": "projectionLineWeight",
"Description": "Projection line weight\n\nint\nDefault value : -1",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "fb1c2c82ba1246a285fda0db6296352d",
"Name": "transparency",
"Description": "Transparency as integer between 1-100.\n\nint\nDefault value : -1",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "bc53526b28d3466d91ff4f7ab33e6984",
"Name": "detailLevel",
"Description": "Detail Level setting, ex: Coarse, Fine etc.\n\nstring\nDefault value : \"Undefined\"",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
},
{
"Id": "3eb3f121e477402ca0b555b461145c41",
"Name": "halftone",
"Description": "Halftone. True = halftone.\n\nbool\nDefault value : false",
"UsingDefaultValue": true,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
}
],
"Outputs": [
{
"Id": "fe06b45c6fb64079bd8b4e3f8e29ee59",
"Name": "overrides",
"Description": "Override Graphic Settings",
"UsingDefaultValue": false,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
}
],
"FunctionSignature": "[email protected],DSCore.Color,DSCore.Color,DSCore.Color,Revit.Elements.FillPatternElement,Revit.Elements.FillPatternElement,Revit.Elements.LinePatternElement,Revit.Elements.LinePatternElement,int,int,int,string,bool",
"Replication": "Auto",
"Description": "Create a OverrideGraphicSettings Element.\n\nOverrideGraphicSettings.ByProperties (cutFillColor: Color = null, projectionFillColor: Color = null, cutLineColor: Color = null, projectionLineColor: Color = null, cutFillPattern: FillPatternElement = null, projectionFillPattern: FillPatternElement = null, cutLinePattern: LinePatternElement = null, projectionLinePattern: LinePatternElement = null, cutLineWeight: int = -1, projectionLineWeight: int = -1, transparency: int = -1, detailLevel: string = \"Undefined\", halftone: bool = false): OverrideGraphicSettings"
}
],
"Connectors": [
{
"Start": "f85bdd071c954afcacc85a75c6d16e68",
"End": "bc53526b28d3466d91ff4f7ab33e6984",
"Id": "e298cc423e5f450096a6735bad65aa9d",
"IsHidden": "False"
}
],
"Dependencies": [],
"NodeLibraryDependencies": [],
"EnableLegacyPolyCurveBehavior": null,
"Thumbnail": "",
"GraphDocumentationURL": null,
"ExtensionWorkspaceData": [
{
"ExtensionGuid": "28992e1d-abb9-417f-8b1b-05e053bee670",
"Name": "Properties",
"Version": "3.2",
"Data": {}
},
{
"ExtensionGuid": "DFBD9CC0-DB40-457A-939E-8C8555555A9D",
"Name": "Generative Design",
"Version": "8.1",
"Data": {}
}
],
"Author": "",
"Linting": {
"activeLinter": "None",
"activeLinterId": "7b75fb44-43fd-4631-a878-29f4d5d8399a",
"warningCount": 0,
"errorCount": 0
},
"Bindings": [],
"View": {
"Dynamo": {
"ScaleFactor": 1.0,
"HasRunWithoutCrash": true,
"IsVisibleInDynamoLibrary": true,
"Version": "3.2.1.5366",
"RunType": "Automatic",
"RunPeriod": "1000"
},
"Camera": {
"Name": "_Background Preview",
"EyeX": 32.549903869628906,
"EyeY": 70.38159942626953,
"EyeZ": 31.292184829711914,
"LookX": 20.782562255859375,
"LookY": -12.580574035644531,
"LookZ": -19.18472671508789,
"UpX": 0.29862523078918457,
"UpY": 0.9136910438537598,
"UpZ": -0.2756657898426056
},
"ConnectorPins": [],
"NodeViews": [
{
"Id": "bc3de6454869447ca4b20524e1ecd92a",
"Name": "Detail Level",
"IsSetAsInput": false,
"IsSetAsOutput": false,
"Excluded": false,
"ShowGeometry": true,
"X": -230.5522902371324,
"Y": 473.5338863097325
},
{
"Id": "aea14b09eeca4137bb5028813db62e8e",
"Name": "OverrideGraphicSettings.ByProperties",
"IsSetAsInput": false,
"IsSetAsOutput": false,
"Excluded": false,
"ShowGeometry": true,
"X": 202.60818673330755,
"Y": 99.71239987826493
}
],
"Annotations": [],
"X": 711.4512426400103,
"Y": -95.95843074355963,
"Zoom": 1.3005875782469958
}
}
14 changes: 14 additions & 0 deletions doc/distrib/NodeHelpFiles/DSRevitNodesUI.DetailLevel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## In Depth
`Detail Level` allows for the selection of a view detail level for use in graphic settings.

Detail levels available include:
- Coarse
- Fine
- Medium
- Undefined

In the example below, graphic settings are created with a coarse detail level setting for use on view elements.
___
## Example File

![Detail Level](./DSRevitNodesUI.DetailLevel_img.jpg)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
102 changes: 102 additions & 0 deletions doc/distrib/NodeHelpFiles/Dynamo.Nodes.DSUvOnElementSelection.dyn
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
{
"Uuid": "2bbdb10f-7e71-44b6-8cf3-99fff16c878e",
"IsCustomNode": false,
"Description": "",
"Name": "Dynamo.Nodes.DSUvOnElementSelection",
"ElementResolver": {
"ResolutionMap": {}
},
"Inputs": [],
"Outputs": [],
"Nodes": [
{
"ConcreteType": "Dynamo.Nodes.DSUvOnElementSelection, DSRevitNodesUI",
"NodeType": "ExtensionNode",
"InstanceId": [
"ad2588d0-c655-4eef-965a-6d983a5e846c-00169397:7:SURFACE"
],
"Id": "1e20083f32b5415a890414252a6c289f",
"Inputs": [],
"Outputs": [
{
"Id": "1d61efdedb8e4d60a1c93a1f4912d189",
"Name": "Point",
"Description": "The selected elements.",
"UsingDefaultValue": false,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
}
],
"Replication": "Disabled",
"Description": "Select a UV on a face."
}
],
"Connectors": [],
"Dependencies": [],
"NodeLibraryDependencies": [],
"EnableLegacyPolyCurveBehavior": null,
"Thumbnail": "",
"GraphDocumentationURL": null,
"ExtensionWorkspaceData": [
{
"ExtensionGuid": "28992e1d-abb9-417f-8b1b-05e053bee670",
"Name": "Properties",
"Version": "3.2",
"Data": {}
},
{
"ExtensionGuid": "DFBD9CC0-DB40-457A-939E-8C8555555A9D",
"Name": "Generative Design",
"Version": "8.1",
"Data": {}
}
],
"Author": "",
"Linting": {
"activeLinter": "None",
"activeLinterId": "7b75fb44-43fd-4631-a878-29f4d5d8399a",
"warningCount": 0,
"errorCount": 0
},
"Bindings": [],
"View": {
"Dynamo": {
"ScaleFactor": 1.0,
"HasRunWithoutCrash": true,
"IsVisibleInDynamoLibrary": true,
"Version": "3.2.1.5366",
"RunType": "Automatic",
"RunPeriod": "1000"
},
"Camera": {
"Name": "_Background Preview",
"EyeX": 32.549903869628906,
"EyeY": 70.38159942626953,
"EyeZ": 31.292184829711914,
"LookX": 20.782562255859375,
"LookY": -12.580574035644531,
"LookZ": -19.18472671508789,
"UpX": 0.29862523078918457,
"UpY": 0.9136910438537598,
"UpZ": -0.2756657898426056
},
"ConnectorPins": [],
"NodeViews": [
{
"Id": "1e20083f32b5415a890414252a6c289f",
"Name": "Select UV on Face",
"IsSetAsInput": false,
"IsSetAsOutput": false,
"Excluded": false,
"ShowGeometry": true,
"X": 255.85625239796792,
"Y": 411.1339305653682
}
],
"Annotations": [],
"X": -505.0250095918717,
"Y": -1455.335722261473,
"Zoom": 4.0
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## In Depth
`Select UV on Face` returns a UV location for the given selection.

In the example below, a UV location is returned for a point selected on a wall in the current Revit document.
___
## Example File

![Select UV on Face](./Dynamo.Nodes.DSUvOnElementSelection_img.jpg)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 9982a93

Please sign in to comment.