◆ Available
| bool FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.Available |
get
True if the property is available in the results for the associated IFlowElement, false otherwise.
Detailed Description
Represents meta-data relating to a property that is populated by a IFlowElement instance.
See the Specification
Inheritance diagram for FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData:
Properties
| string | Name [get]
The name of the property. More...
|
| IFlowElement | Element [get]
The IFlowElement that this property is associated with. More...
|
| string | Category [get]
The category the property belongs to. More...
|
| Type | Type [get]
The type of the property values More...
|
| bool | Available [get]
True if the property is available in the results for the associated IFlowElement, false otherwise. More...
|
| IReadOnlyList< IElementPropertyMetaData > | ItemProperties [get]
This is only relevant where Type is a collection of complex objects. More...
|
| IReadOnlyDictionary< string, IElementPropertyMetaData > | ItemPropertyDictionary [get]
Get the ItemProperties as a dictionary keyed on property name. More...
|
| bool | DelayExecution [get]
|
| IReadOnlyList< string > | EvidenceProperties [get]
Get the names of any JavaScript properties that, when executed, will obtain additional evidence that can help in determining the value of this property. More...
|
Property Documentation
◆ Category
| string FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.Category |
get
The category the property belongs to.
◆ DelayExecution
| bool FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.DelayExecution |
get
Only relevant if Type is JavaScript.
Defaults to false. If set to true then the JavaScript in this property will not be executed automatically on the client device. This is used where executing the JavaScript would result in
undesirable behavior. For example, attempting to access the location of the device will cause the browser to show a pop-up confirming if the user is happy too allow the website access to their location. In general, we don't want this to happen immediately when a user enters a website, but when they try to use a feature that requires location data (e.g. show restaurants near me).
◆ Element
| IFlowElement FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.Element |
get
The IFlowElement that this property is associated with.
◆ EvidenceProperties
| IReadOnlyList<string> FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.EvidenceProperties |
get
Get the names of any JavaScript properties that, when executed, will obtain additional evidence that can help in determining the value of this property.
For example, the ScreenPixelsWidthJavascript property will get the pixel width of the client-device's screen. This is used to update the ScreenPixelsWidth property. As such, ScreenPixelsWidth will have ScreenPixelWidthJavascript in its list of evidence properties.
◆ ItemProperties
| IReadOnlyList<IElementPropertyMetaData> FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.ItemProperties |
get
This is only relevant where Type is a collection of complex objects.
It contains a list of the property meta-data for the items in the value for this property. For example, if this meta-data instance represents a list of hardware devices, ItemProperties will contain a list of the meta-data for properties available on each hardware device element within that list.
◆ ItemPropertyDictionary
| IReadOnlyDictionary<string, IElementPropertyMetaData> FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.ItemPropertyDictionary |
get
Get the ItemProperties as a dictionary keyed on property name.
◆ Name
| string FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.Name |
get
The name of the property.
Must match the string key used to store the property value in the IElementData instance.
◆ Type
| Type FiftyOne.Pipeline.Core.Data.IElementPropertyMetaData.Type |
get
The type of the property values