Scripts/New-UDGauge.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<#
.SYNOPSIS
    Sample control for UniversalDashboard.
.DESCRIPTION
    Sample control function for UniversalDashboard. This function must have an ID and return a hash table.
.PARAMETER Id
    An id for the component default value will be generated by new-guid.
.EXAMPLE
    PS C:\> <example usage>
    Explanation of what the example does
.INPUTS
    Inputs (if any)
.OUTPUTS
    Output (if any)
.NOTES
    General notes
#>

function New-UDGauge {
    param(
        [Parameter()]
        [string]$Id = (New-Guid).ToString(),
        [Parameter()]
        [int]$MaxValue = 100,
        [Parameter()]
        [int]$Value = 50,
        [Parameter()]
        [string]$NeedleColor = "steelblue",
        [Parameter()]
        [string]$StartColor = "green",
        [Parameter()]
        [string]$EndColor = "red",
        [Parameter()]
        [int]$Segments = 10,
        [Parameter()]
        [int]$SegmentLabels = 5,
        [Parameter()]
        [float]$NeedleHeight = "0.8",
        [Parameter()]
        [int]$NeedleTransition = 4000,
        [Parameter()]
        [string]$LabelFontSize = "20px",
        [Parameter()]
        [string]$ValueFontSize = "24px",
        [Parameter()]
        [int]$PaddingHorizontal = 17,
        [Parameter()]
        [int]$PaddingVertical = 17,
        [Parameter()]
        [string]$ValueText,
        [Parameter()]
        [int]$Width = 320,
        [Parameter()]
        [int]$Height = 195,
        [Parameter()]
        [string]$TextColor = "#A7A7A7"
    )

    End {

        @{
            # The AssetID of the main JS File
            assetId                  = $AssetId
            # Tell UD this is a plugin
            isPlugin                 = $true
            # This ID must be the same as the one used in the JavaScript to register the control with UD
            type                     = "UD-Gauge"
            # An ID is mandatory
            id                       = $Id

            # This is where you can put any other properties. They are passed to the React control's props
            # The keys are case-sensitive in JS.
            maxValue                 = $MaxValue
            value                    = $Value
            needleColor              = $NeedleColor
            startColor               = $StartColor
            endColor                 = $EndColor
            segments                 = $Segments
            maxSegmentLabels         = $SegmentLabels
            needleHeightRatio        = $NeedleHeight
            needleTransitionDuration = $NeedleTransition
            labelFontSize            = $LabelFontSize
            valueTextFontSize        = $ValueFontSize
            paddingHorizontal        = $PaddingHorizontal
            paddingVertical          = $PaddingVertical
            currentValueText         = $ValueText
            width                    = $Width
            height                   = $Height
            textColor                = $TextColor

        }

    }
}