# WireCurrentsQuantity

The wire currents and charges quantity properties.

## Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]])

-- Obtain the 3D view and add a wire current plot

view = app.Views[1]

-- Normalise the values on the graph and scale to dB

quantity = plot.Quantity
quantity.ValuesNormalised = true
quantity.ValuesScaledToDB = true


## Usage locations (object properties)

The following objects have properties using the WireCurrentsQuantity object:

## Property List

ComplexComponent
The complex component of the wire currents value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Instantaneous. (Read/Write ComplexComponentEnum)
InstantaneousPhase
The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees [0,360]. (Read/Write number)
QuantityType
The type of wire currents quantity to be plotted, specified by the WireCurrentsQuantityTypeEnum, e.g. Currents or Charges. (Read/Write WireCurrentsQuantityTypeEnum)
SortBy
The wire currents sorting dimension, specified by the WireCurrentsSortEnum, e.g. ByIndex, ByX, ByY or ByZ. This property is only valid when the IndependentAxis is set to “Segments”. (Read/Write WireCurrentsSortEnum)
ValuesNormalised
Specifies whether the wire currents quantity values must be normalised to the range [0,1] before plotting. This property can be used together with dB scaling. (Read/Write boolean)
ValuesScaledToDB
Specifies whether the wire currents quantity values are scaled to dB before plotting. (Read/Write boolean)

## Property Details

ComplexComponent
The complex component of the wire currents value to plot, specified by the ComplexComponentEnum, e.g. Magnitude, Instantaneous.
Type
ComplexComponentEnum
Access
InstantaneousPhase
The phase value (wt) to use when ComplexComponent is Instantaneous. The value is in degrees [0,360].
Type
number
Access
QuantityType
The type of wire currents quantity to be plotted, specified by the WireCurrentsQuantityTypeEnum, e.g. Currents or Charges.
Type
WireCurrentsQuantityTypeEnum
Access
SortBy
The wire currents sorting dimension, specified by the WireCurrentsSortEnum, e.g. ByIndex, ByX, ByY or ByZ. This property is only valid when the IndependentAxis is set to “Segments”.
Type
WireCurrentsSortEnum
Access