Jump to content

GraphChart class: Difference between revisions

From LabVIEW Wiki
← Older edit
VisualWikitext
mNo edit summary
m Removed VI Server Category from page
 
(One intermediate revision by the same user not shown)
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 GraphChart Properties Table</span>
{{VIServerClassTables|22}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ GraphChart Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6341C10
| [[GraphChart class/ActXScl property|ActXScl]]
|Gets or sets the active or current X-scale of a graph or chart.
 
This property is similar to the <b>Scale</b> option on the <b>Scales</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C11
| [[GraphChart class/ActYScl property|ActYScl]]
|Gets or sets the active or current Y-scale of a graph or chart. Call this property before setting other properties on a specific scale.
 
This property is similar to the Y-Scale item on the shortcut menu of a chart or graph.
 
This property is similar to the <b>Scale</b> option on the <b>Scales</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C1A
| [[GraphChart class/AutoscaleDelay property|AutoscaleDelay]]
|Number of seconds that elapse between two successive autoscale operations when the scale has to shrink to fit the data. This delay has no effect on autoscale operations that happen in response to data that causes the scale to grow in range.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C1B
| [[GraphChart class/Frame Color property|Frame Color]]
|Gets or sets the frame color of the graph or chart.
 
The numeric value of this property corresponds to the color a color box constant displays for the same value. That color value is expressed as a hexadecimal number with the form RRGGBB. The first two digits control the red color value. The second two digits control the green color value. The last two digits control the blue color value.
|R/W
|X
|- style="background-color:#D1BB80;"
|6341C15
| [[GraphChart class/Flavor property|Flavor]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|6341C0F
| [[GraphChart class/ActPaletteTool property|ActPaletteTool]]
|Sets the tool that is currently selected on the graph palette. 0 is the selection cursor and 1 is the panning tool. 2-7 are the zoom tools: 2 is Zoom to Rectangle, 3 is X-zoom, 4 is Y-zoom, 5 is Zoom to Fit, 6 is Zoom Out about Point, and 7 is Zoom In about Point.
 
<b>Note</b>  The Zoom to Fit tool zooms in or out to autoscale the graph or chart. Because the Zoom to Fit tool does not have a cursor, LabVIEW continues to display the cursor for the previous selected tool.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C03
| [[GraphChart class/PaletteVis property|PaletteVis]]
|Shows the graph palette.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C19
| [[GraphChart class/Plot Bounds property|Plot Bounds]]
|Gets and sets the plot area bounds for the Graph and Chart. If it is a stacked chart, this property returns the bounds of the first plot area. You cannot set the plot area bounds for a stacked chart.
 
{| 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;"|Left
|The horizontal coordinate of the left edge of the plot area.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Top
|The vertical coordinate of the top edge of the plot area.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Right
|The horizontal coordinate of the right edge of the plot area.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Bottom
|The vertical coordinate of the bottom edge of the plot area.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C05
| [[GraphChart class/PlotAreaColors property|PlotAreaColors]]
|Colors of the plotting area expressed in terms of (Foreground Color, Background Color) pair.
 
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.
 
{| 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;"|Foreground Color
|Foreground color of the plotting area.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Background Color
|Background color of the plotting area.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C07
| [[GraphChart class/BG Color property|BG Color]]
|Background color of the plotting area.
 
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.
 
This property is an element of the Plot Area:Colors property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C06
| [[GraphChart class/FG Color property|FG Color]]
|Foreground color of the plotting area.
 
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.
 
This property is an element of the Plot Area:Colors property.
|R/W
|X
|- style="background-color:#D1BB80;"
|6341C16
| [[GraphChart class/PlotAreaPos property|PlotAreaPos]]
|
|R
|X
|- style="background-color:#D1BB80;"
|6341C17
| [[GraphChart class/PlotAreaLeft property|PlotAreaLeft]]
|
|R
|X
|- style="background-color:#D1BB80;"
|6341C18
| [[GraphChart class/PlotAreaTop property|PlotAreaTop]]
|
|R
|X
|- style="background-color:#FFFFCC;"
|6341C00
| [[GraphChart class/PlotAreaSize property|PlotAreaSize]]
|Size of the active plotting area in terms of width and height in pixels.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C02
| [[GraphChart class/Height property|Height]]
|Height of the active plotting area in pixels.
 
This property is an element of the Plot Area:Size property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C01
| [[GraphChart class/Width property|Width]]
|Width of the active plotting area in pixels.
 
This property is an element of the Plot Area:Size property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C12
| [[GraphChart class/ScaleLegendVis property|ScaleLegendVis]]
|Shows the scale legend.
 
This property is similar to the <b>Visible Items&#0187;Scale Legend</b> item on the shortcut menu of a graph or chart.
 
This property is similar to the <b>Show scale legend</b> option on the <b>Appearance</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C04
| [[GraphChart class/TransposeArr property|TransposeArr]]
|Transpose data before plotting (switch X and Y).
 
This property is similar to the Transpose Array item on the shortcut menu of a graph or chart.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C0B
| [[GraphChart class/XScale property|XScale]]
|Reference to the X-scale.
 
You can use this reference with the GraphScale properties.
 
This property is similar to the X Scale item on the shortcut menu of a graph or chart.
 
This property is similar to the <b>Scale</b> option on the <b>Scales</b> page of the Properties dialog box.
|R
|X
|- style="background-color:#FFFFCC;"
|6341C14
| [[GraphChart class/ScrollVis property|ScrollVis]]
|Displays the x-axis scroll bar for the graph or chart.
 
This property is similar to the <b>Visible Items&#0187;</b>X Scrollbar item on the shortcut menu of a graph or chart.
 
This property is similar to the <b>Show x scroll bar</b> option on the <b>Appearance</b> page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6341C0C
| [[GraphChart class/YScale property|YScale]]
|Reference to the Y-scale.
 
You can use this reference with the GraphScale properties.
 
This property is similar to the Y Scale item on the shortcut menu of a graph or chart.
 
This property is similar to the <b>Scale</b> option on the <b>Scales</b> page of the Properties dialog box.
|R
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide GraphChart Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ GraphChart Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|6341802
| [[GraphChart class/ForceRedraw method|ForceRedraw]]
|Forces LabVIEW to redraw the graph.
|X
|- style="background-color:#FFFFCC;"
|6341800
| [[GraphChart class/Map Coords To XY method|Map Coords To XY]]
|Maps the owning pane coordinates to the XY location on a graph. If the scales are not specified then the active or current scales are used.
|X
|- style="background-color:#FFFFCC;"
|6341801
| [[GraphChart class/Map XY To Coords method|Map XY To Coords]]
|Returns TRUE and maps the XY location on a graph to the owning pane coordinates. If you do not specify the scales, LabVIEW uses the active or current scales. This method is useful when you need to map graph coordinates to plot image coordinates to draw images inside the plot area of a graph.
 
This method adjusts only the left and top plot bounds to orient the plot around the origin of the owning pane.
|X
|}
</div>
 
==Events==
<span class="mw-customtoggle-eventstable">Show/Hide GraphChart Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{| class="wikitable sortable"
|+ GraphChart Events Table
! Code
! Name
! Type
|- style="background-color:#FFFFCC;"
|1073741904
|[[GraphChart class/Annotation Menu Selection event|Annotation Menu Selection]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483727
|[[GraphChart class/Annotation Menu Selection? event|Annotation Menu Selection?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741900
|[[GraphChart class/Autoscale Range Change event|Autoscale Range Change]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741902
|[[GraphChart class/Cursor Menu Selection event|Cursor Menu Selection]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483725
|[[GraphChart class/Cursor Menu Selection? event|Cursor Menu Selection?]]
|Filter
|- style="background-color:#FFFFCC;"
|1073741862
|[[GraphChart class/Plot Attribute Change event|Plot Attribute Change]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741861
|[[GraphChart class/Scale Range Change event|Scale Range Change]]
|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
Line 313: Line 24:
*[[VI Server]]
*[[VI Server]]


[[Category:VI Server]]
 
[[Category:VI Server Class]]
[[Category:VI Server Class]]

Latest revision as of 02:01, 8 May 2020

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


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

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

Properties

Show/Hide GraphChart Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
GraphChart Properties Table
Property ID Long Name (English) Description R/W RTE
6341C00Plot Area:SizeSize of the active plotting area in terms of width and height in pixels.Read/WriteYes
6341C01Plot Area:Size:WidthWidth of the active plotting area in pixels.Read/WriteYes
6341C02Plot Area:Size:HeightHeight of the active plotting area in pixels.Read/WriteYes
6341C03Palette:VisibleShows the graph palette.Read/WriteYes
6341C04Transpose ArrayTranspose data before plotting (switch X and Y).Read/WriteYes
6341C05Plot Area:ColorsColors of the plotting area expressed in terms of (Foreground Color, Background Color) pair.Read/WriteYes
6341C06Plot Area:Colors:FG ColorForeground color of the plotting area.Read/WriteYes
6341C07Plot Area:Colors:BG ColorBackground color of the plotting area.Read/WriteYes
6341C08Grid ColorsRead/WriteYes
6341C09Grid Colors:X ColorRead/WriteYes
6341C0AGrid Colors:Y ColorRead/WriteYes
6341C0BX ScaleReference to the X-scale.Read OnlyYes
6341C0CY ScaleReference to the Y-scale.Read OnlyYes
6341C0DX Scale InfoRead/WriteYes
6341C0EY Scale InfoRead/WriteYes
6341C0FPalette:Active ToolSets the tool that is currently selected on the graph palette. 0 is the selection cursor and 1 is the panning tool. 2-7 are the zoom tools: 2 is Zoom to Rectangle, 3 is X-zoom, 4 is Y-zoom, 5 is Zoom to Fit, 6 is Zoom Out about Point, and 7 is Zoom In about Point.Read/WriteYes
6341C10Active X ScaleGets or sets the active or current X-scale of a graph or chart.Read/WriteYes
6341C11Active Y ScaleGets or sets the active or current Y-scale of a graph or chart. Call this property before setting other properties on a specific scale.Read/WriteYes
6341C12Scale Legend:VisibleShows the scale legend.Read/WriteYes
6341C14X Scrollbar VisibleDisplays the x-axis scroll bar for the graph or chart.Read/WriteYes
6341C15Graph FlavorRead OnlyYes
6341C16Plot Area:PositionRead OnlyYes
6341C17Plot Area:Position:LeftRead OnlyYes
6341C18Plot Area:Position:TopRead OnlyYes
6341C19Plot Area BoundsGets and sets the plot area bounds for the Graph and Chart. If it is a stacked chart, this property returns the bounds of the first plot area. You cannot set the plot area bounds for a stacked chart.Read/WriteYes
6341C1AAutoscale DelayNumber of seconds that elapse between two successive autoscale operations when the scale has to shrink to fit the data. This delay has no effect on autoscale operations that happen in response to data that causes the scale to grow in range.Read/WriteYes
6341C1BFrame ColorGets or sets the frame color of the graph or chart.Read/WriteYes

Methods

Show/Hide GraphChart Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
GraphChart Methods Table
Method ID Long Name (English) Description RTE
6341800Map Coordinates To XYMaps the owning pane coordinates to the XY location on a graph. If the scales are not specified then the active or current scales are used.Yes (Read/Write)
6341801Map XY To CoordinatesReturns TRUE and maps the XY location on a graph to the owning pane coordinates. If you do not specify the scales, LabVIEW uses the active or current scales. This method is useful when you need to map graph coordinates to plot image coordinates to draw images inside the plot area of a graph.Yes (Read/Write)
6341802Force RedrawForces LabVIEW to redraw the graph.Yes (Read/Write)

Events

Show/Hide GraphChart Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
GraphChart Events Table
Code Name Description Type
1073741904Annotation Menu SelectionGenerated when the user selects a menu item from the shortcut menu of an annotation. This event is posted after the built-in shortcut menu item is processed by LabVIEW.Notify
2147483727Annotation Menu Selection?Generated when the user selects a menu item from the shortcut menu of an annotation. This event is posted before the built-in shortcut menu item is processed by LabVIEW.Filter
1073741900Autoscale Range ChangeNotify
1073741902Cursor Menu SelectionGenerated when the user selects a menu item from the shortcut menu of the cursor legend. This event is posted after the built-in shortcut menu item is processed by LabVIEW.Notify
2147483725Cursor Menu Selection?Generated when the user selects a menu item from the shortcut menu of the cursor legend. This event is posted before the built-in shortcut menu item is processed by LabVIEW.Filter
1073741862Plot Attribute ChangeGenerated when the user changes an attribute of a plot on a graph or chart by right-clicking the plot in the plot legend and selecting an item from the shortcut menu. This event is useful if you want to register user changes and then adjust the functionality of the graph.Notify
1073741861Scale Range ChangeGenerated when the user changes the minimum or maximum value of the scale of a graph or chart. The minimum or maximum value changes when the user enters a new value in a scale marker, pans or zooms the graph or chart, or the graph or chart autoscales. This event is useful if you want to register user changes and then adjust the functionality of the graph.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=GraphChart_class&oldid=26664"