Jump to content

IntensityGraph class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
Visual
mNo edit summary
Replaced with template tables
Tag: Replaced
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide IntensityGraph Properties Table</span>
{{VIServerClassTables|26}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ IntensityGraph Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6344C05
| [[IntensityGraph class/ActCrsr property|ActCrsr]]
|Use this property to get and set the active cursor and set properties and methods on that cursor.
 
For example, you can use the Selected Cursors property to indicate which cursor you have currently selected on a graph or chart, then use the Active Cursor property to set that cursor to the cursor you want to modify using cursor properties and methods. The Active Cursor does not return the user selected cursor. Use the Selected Cursor property to get the user selected cursor.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C0E
| [[IntensityGraph class/AnntList property|AnntList]]
|Array of information about all annotations. Each array element is a cluster of annotation elements.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Name
|The text displayed in the plot area that is associated with the annotation.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Color
|The color of the annotation, including its point, arrow, and name.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Style
|The symbol that, in combination with Point Style, is drawn at the focal point of the annotation. Valid values are 0-8, as shown on the <b>Annotation Style</b> shortcut menu item of the annotation from top-left to bottom-right.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Point Style
|The symbol that, in combination with Style, is drawn at the focal point of the annotation. Valid values are 0-16, as shown on the <b>Point Style</b> shortcut menu item of the annotation from top-left to bottom-right.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Name Visible
|If TRUE, displays the annotation name in the plot area.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Allow Drag
|If TRUE, allows you to drag the annotation.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Annotation Mode
|Specifies the way in which the annotation snaps to the plots in the plot area. Valid values include 0 (Free) and 1 (Single-plot).
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Plot
|The plot with which the annotation is associated. If Plot is -1, the annotation snaps to all plots in the plot area. You can move the annotation to the nearest data point along any plot in the plot area. This element does not apply to free annotations.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Index
|The array index of the point to which the annotation is snapped.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Position:X
|The x coordinate of the annotation in the plot area. Position:X is in the coordinate system of the X Scale value that is associated with the annotation or plot.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Position:Y
|The y coordinate of the annotation in the plot area. Position:Y is in the coordinate system of the Y Scale value that is associated with the annotation or plot.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|X Scale
|The x-scale associated with the annotation. This element applies only to free annotations and defines which x-scale is used with Position:X.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Y Scale
|The y-scale associated with the annotation. This element applies only to free annotations and defines which y-scale is used with Position:Y.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Show Arrow
|If TRUE, displays the arrow that points from the annotation name to the annotated data point.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Lock Name
|If TRUE, positions the annotation name absolutely so that when you move the annotation or scroll the plot area, the annotation name does not move in the plot area.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Plot Area
|The plot area with which the annotation is associated. This element applies only to mixed signal graphs with multiple plot areas.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Label Offset:X
|The X coordinate of the label position, relative to the annotation.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Label Offset:Y
|The Y coordinate of the label position, relative to the annotation.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C04
| [[IntensityGraph class/ColorTbl property|ColorTbl]]
|Array of 256 colors defining the color map.
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C06
| [[IntensityGraph class/Cursor property|Cursor]]
|Reference to active cursor.
 
You can use this reference with the Cursor properties.
 
This property is similar to the <b>Cursor</b> option on the Cursors page of the <b>Intensity Graph Properties</b> dialog box.
|R
|X
|- style="background-color:#FFFFCC;"
|6344C0A
| [[IntensityGraph class/Cursor Legend Vis property|Cursor Legend Vis]]
|Displays the cursor legend.
 
This property is similar to the <b>Visible Items&#0187;Cursor Legend</b> item on the shortcut menu of an intensity graph control.
 
This property is similar to the <b>Show cursor legend</b> option on the Appearance page of the <b>Intensity Graph Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C0F
| [[IntensityGraph class/CrsrList property|CrsrList]]
|Array of information about all cursors. Each array element is a cluster of Cursor properties.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Name
|Text displayed in the plot area that is associated with the cursor.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Color
|The color of the cursor, including its point, arrow, and name.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Style
|The symbol that, in combination with Point Style, is drawn at the focal point of the cursor. Valid values are 0-8, from top-left to bottom-right, as shown when you right-click a cursor in the cursor legend and select Attribute&#0187;Cursor Style from the shortcut menu.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Point Style
|The symbol that, in combination with Style, is drawn at the focal point of the cursor. Valid values are 0-16, as shown on the shortcut menu of the plot legend from top-left to bottom-right.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Name Visible
|If TRUE, displays the cursor name in the plot area.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Allow Drag
|If TRUE, allows you to drag the cursor.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Cursor Mode
|Specifies the way in which the cursor snaps to the plots in the plot area. Valid values include 0 (Free), 1 (Single-plot), and 2 (Multi-plot).
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Plot
|Plot with which the cursor is associated. If Plot is –1, the cursor snaps to all plots in the plot area. You can move the cursor to the nearest data point along any plot in the plot area.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Index
|Array index of the point to which the cursor is snapped. This property can have a value between 0 and the number of data points minus 1.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Position
|Position of cursor in terms of X-Y coordinates.
*X&#8212;The coordinate that defines the position of the cursor along the X-axis.
*Y&#8212;The coordinate that defines the position of the cursor along the Y-axis.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|X Scale
|Sets the X-scale of the cursor. This property is valid only for free cursors. When the cursor is associated with a plot, this property might be overwritten by the plot.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Y Scale
|Sets the Y-scale of the cursor. This property is valid only for free cursors. When the cursor is associated with a plot, this property might be overwritten by the plot.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Watch Plots
|Array that contains the indexes of the plots that the cursor is watching when Watch All Plots is set to FALSE. This element is valid only for cursors that are associated with multiple plots.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Watch All Plots
|If TRUE, the cursor watches all plots in the plot area. If FALSE, the cursor watches only the plots specified by Watch Plots. This element is valid only for cursors that are associated with multiple plots.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Plot Area
|The plot area with which the cursor is associated. This element applies only to Mixed Signal graphs.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Label Offset
|The coordinates of the label position relative to the cursor.
*X&#8212;The X coordinate of the label position relative to the cursor.
*Y&#8212;The Y coordinate of the label position relative to the cursor.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C10
| [[IntensityGraph class/CrsrsScrollGrph property|CrsrsScrollGrph]]
|Gets or sets whether dragging the cursor outside the bounds of the graph continues to scroll the graph. Set this property to TRUE to allow scrolling outside the bounds of the graph.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C03
| [[IntensityGraph class/IgnoreArr property|IgnoreArr]]
|Indicate use of Color Table instead of Z Scale color settings.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C0B
| [[IntensityGraph class/PlotImages.Front property|PlotImages.Front]]
|Sets the plot area foreground image, which is in front of the plot data.
 
This property is useful if you want to insert an image, such as custom data point annotations, into the foreground of the graph plot area.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C08
| [[IntensityGraph class/SelectedCrsrs property|SelectedCrsrs]]
|Displays the currently selected cursor.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C01
| [[IntensityGraph class/SmoothUpdt property|SmoothUpdt]]
|Draws graph with less flicker, but slightly slower. (Mac OS X) LabVIEW ignores this property.
 
This property is similar to the <b>Advanced&#0187;Smooth Updates</b> item on the shortcut menu of an intensity graph.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6344C02
| [[IntensityGraph class/ZScale property|ZScale]]
|Reference to the Z-Scale.
 
You can use this reference with the ColorGraphScale properties.
 
This property is similar to the <b>Z Scale</b> item on the shortcut menu of an intensity graph.
 
This property is similar to the <b>Z-Scale</b> option on the Scales page of the <b>Intensity Graph Properties</b> dialog box.
|R
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide IntensityGraph Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ IntensityGraph Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|6344800
| [[IntensityGraph class/Export Data to Clipboard method|Export Data to Clipboard]]
|Exports the graph data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.
|X
|- style="background-color:#FFFFCC;"
|6344801
| [[IntensityGraph class/Export Data to Excel method|Export Data to Excel]]
|Exports the graph data to Excel.
|X
|}
</div>
 
==Events==
<span class="mw-customtoggle-eventstable">Show/Hide IntensityGraph Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{| class="wikitable sortable"
|+ IntensityGraph Events Table
! Code
! Name
! Type
|- style="background-color:#FFFFCC;"
|1073741864
|[[IntensityGraph class/Cursor Grab event|Cursor Grab]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483687
|[[IntensityGraph class/Cursor Grab? event|Cursor Grab?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741865
|[[IntensityGraph class/Cursor Move event|Cursor Move]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741866
|[[IntensityGraph class/Cursor Release event|Cursor Release]]
|Notify
|}
</div>


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version

Revision as of 21:58, 8 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name IntensityGraph class
Class ID 26
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


    This article is a stub. You can help LabVIEW Wiki by expanding it.
    Please improve this article if you can.

    The IntensityGraph class is a class in the VI Server Class Hierarchy, (see also VI Server).

    Properties

    Show/Hide IntensityGraph Properties Table

    Legend
    R/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    IntensityGraph Properties Table
    Property ID Long Name (English) Description R/W RTE
    6344C01Smooth UpdateDraws graph with less flicker, but slightly slower. (Mac OS X) LabVIEW ignores this property.Read/WriteYes
    6344C02Z ScaleReference to the Z-Scale.Read OnlyYes
    6344C03Ignore ArrayIndicate use of Color Table instead of Z Scale color settings.Read/WriteYes
    6344C04Color TableArray of 256 colors defining the color map.Read/WriteYes
    6344C05Active CursorUse this property to get and set the active cursor and set properties and methods on that cursor.Read/WriteYes
    6344C06CursorReference to active cursor.Read OnlyYes
    6344C07Old Cursor ListRead/WriteYes
    6344C08Selected CursorsDisplays the currently selected cursor.Read/WriteYes
    6344C09Z Scale InfoRead/WriteYes
    6344C0ACursor Legend VisibleDisplays the cursor legend.Read/WriteYes
    6344C0BPlot Images:FrontSets the plot area foreground image, which is in front of the plot data.Read/WriteYes
    6344C0COld Annotation ListRead/WriteYes
    6344C0DOld Cursor ListRead/WriteYes
    6344C0EAnnotation ListArray of information about all annotations. Each array element is a cluster of annotation elements.Read/WriteYes
    6344C0FCursor ListArray of information about all cursors. Each array element is a cluster of Cursor properties.Read/WriteYes
    6344C10Cursors Scroll GraphGets or sets whether dragging the cursor outside the bounds of the graph continues to scroll the graph. Set this property to TRUE to allow scrolling outside the bounds of the graph.Read/WriteYes

    Methods

    Show/Hide IntensityGraph Properties Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    IntensityGraph Methods Table
    Method ID Long Name (English) Description RTE
    6344800Export Data to ClipboardExports the graph data to the clipboard in a tab-delimited format, which is accepted by most spreadsheet applications.Yes (Read/Write)
    6344801Export Data to ExcelExports the graph data to Excel.Yes (Read/Write)

    Events

    Show/Hide IntensityGraph Events Table

    Legend
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    IntensityGraph Events Table
    Code Name Description Type
    1073741864Cursor GrabGenerated when the user first clicks the graph cursor to move it. This event is useful if you want to register when a user interacts with a graph cursor.Notify
    2147483687Cursor Grab?Generated when the user first clicks the cursor to move it. This event is useful if you want to register when a user interacts with a graph cursor, or if you want to disable user interaction with the graph cursors.Filter
    1073741865Cursor MoveGenerated when the user moves a cursor either by clicking and dragging the cursor or using the Cursor Movement Tool.Notify
    1073741866Cursor ReleaseGenerated when the user releases the cursor after dragging it. This event is useful if you want to register when a user has finished interacting with a graph cursor.Notify


    History

    History information is needed. What changes have occurred over previous versions?
    Version Change(s)
    LabVIEW 2018 More info to come.

    See Also

    Retrieved from "https://labviewwiki.org/w/index.php?title=IntensityGraph_class&oldid=9749"