Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

CDViewPortManagerMBS.canZoomIn(zoomDirection as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Checks if it is possible to zoom in further at a certain direction without violating zoom in limits.
Notes:
See ViewPortManager.setZoomInWidthLimit and ViewPortManager.setZoomInHeightLimit on how to configure zoom in limits.
ArgumentDefaultDescription
zoomDirection(Mandatory)The zoom direction to check. Must be one of the predefined constants DirectionHorizontal, DirectionVertical and DirectionHorizontalVertical for horizontal, vertical and bi-directional zooming.
Return Value
True if can zoom in further, otherwise false.

Feedback, Comments & Corrections

CDViewPortManagerMBS.canZoomOut(zoomDirection as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Checks if it is possible to zoom out further at a certain direction without violating zoom out limits.
Notes:
See ViewPortManager.setZoomOutWidthLimit and ViewPortManager.setZoomOutHeightLimit on how to configure zoom out limits.
ArgumentDefaultDescription
zoomDirection(Mandatory)The zoom direction to check. Must be one of the predefined constants DirectionHorizontal, DirectionVertical and DirectionHorizontalVertical for horizontal, vertical and bi-directional zooming.
Return Value
True if can zoom out further, otherwise false.

Feedback, Comments & Corrections

CDViewPortManagerMBS.clearAllRanges
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: A convenience method to clear all the ranges configured using setFullRange.

Feedback, Comments & Corrections

CDViewPortManagerMBS.commitPendingSyncAxis(baseChart as CDBaseChartMBS)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: The commitPendingSyncAxis is a method to actually perform the function in syncLinearAxisWithViewPort, syncLogAxisWithViewPort and syncDateAxisWithViewPort.

Feedback, Comments & Corrections

CDViewPortManagerMBS.Constructor
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Creates a new viewport.

Feedback, Comments & Corrections

CDViewPortManagerMBS.dragTo(scrollDirection as Integer, x as Integer, y as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Scrolls the view port to reflect dragging of the underlying rectangular surface.
Notes:
The amount of drag is measured as changed in mouse cursor coordinates since the call to ViewPortManager.startDrag. A positive change means the dragging is to the right or bottom. A negative change means the dragging is to the left or top.

The drag is considered as applying to the underlying surface. The view port moves in the opposite direction to the drag. For example, dragging the underlying surface to the right is equivalent to moving the view port to the left.

The view port may not change at all if it has reached the borders of the underlying surface.
ArgumentDefaultDescription
scrollDirection(Mandatory)The allowed scroll direction. Must be one of the predefined constants DirectionHorizontal, DirectionVertical and DirectionHorizontalVertical for horizontal, vertical and bi-directional scrolling.
deltaX(Mandatory)The change in mouse x-coordinates. A positive change means the drag is to the right. A negative change means the drag is to the right.
deltaY(Mandatory)The change in mouse y-coordinates. A positive change means the drag is to the bottom. A negative change means the drag is to the top.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getPlotAreaHeight as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the height of the plot area in pixels.
Notes:
Return Value
The height of the plot area in pixels.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getPlotAreaLeft as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the x-coordinate of the left side of the plot area in pixels.
Notes:
Return Value
The x-coordinate of the left side of the plot area in pixels.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getPlotAreaTop as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the y-coordinate of the top side of the plot area in pixels.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getPlotAreaWidth as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the width of the plot area in pixels.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getValueAtViewPort(id as string, ratio as Double, isLogScale as boolean = false) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Converts a view port coordinate to a value of the specified data scale.
Notes:
Please refer to ViewPortManager.setFullRange on how to define a data scale.

ArgumentDefaultDescription
id(Mandatory)The name of the data scale.
vpCoor(Mandatory)The view port coordinate.
isLogScalefalsetrue if the conversion is based on a logarithmic scale. false if the conversion is based on a non-logarithmic scale.

Returns the value of the specified data scale at the view port coordinate.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getViewPortAtValue(id as string, ratio as Double, isLogScale as boolean = false) as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Converts a value of the specified data scale to a view port coordinate.
Notes:
Please refer to ViewPortManager.setFullRange on how to define a data scale.

ArgumentDefaultDescription
id(Mandatory)The name of the data scale.
value(Mandatory)The value to be converted.
isLogScalefalsetrue if the conversion is based on a logarithmic scale. false if the conversion is based on a non-logarithmic scale.

Returns the view port coordinate at the value of the specified data scale.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getViewPortHeight as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the height of the view port.
Notes: The view port height is expressed as a fraction of the height of the underlying surface. It should be between 0 and 1.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getViewPortLeft as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the position of the left side of the view port.
Notes: The position of the view port left side is its distance from the left side of the underlying surface, as a fraction of the width of the underlying surface. It should be between 0 and 1.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getViewPortTop as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the position of the top side of the view port.
Notes: The position of the view port top side is its distance from the top side of the underlying surface, as a fraction of the height of the underlying surface. It should be between 0 and 1.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getViewPortWidth as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the width of the view port.
Notes: The view port width is expressed as a fraction of the width of the underlying surface. It should be between 0 and 1.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getZoomInHeightLimit as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the view port height at maximum zoom in for mouse zoom in actions.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getZoomInWidthLimit as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the view port width at maximum zoom in for mouse zoom in actions.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getZoomOutHeightLimit as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the view port height at maximum zoom out for mouse zoom out actions.

Feedback, Comments & Corrections

CDViewPortManagerMBS.getZoomOutWidthLimit as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Gets the view port width at maximum zoom out for mouse zoom out actions.

Feedback, Comments & Corrections

CDViewPortManagerMBS.inExtendedPlotArea(x as Integer, y as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Determines if a given (x, y) coordinate is within the extended plot area (the plot area plus the extra margin sets up using setPlotAreaMouseMargin).

Feedback, Comments & Corrections

CDViewPortManagerMBS.inPlotArea(x as Integer, y as Integer) as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Determines if a given point is within the plot area.
Notes:
ArgumentDefaultDescription
x(Mandatory)The x coordinate of the point in pixel unit.
y(Mandatory)The y coordinate of the point in pixel unit.
Return Value
True if the point is within the plot area, otherwise false.

Feedback, Comments & Corrections

CDViewPortManagerMBS.setChartMetrics(metrics as string)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the chart metrics to the ViewPortManager so it knows the positions of the necessary chart objects for supporting view ports.
Notes:
ArgumentDefaultDescription
metrics(Mandatory)A text string obtained from BaseChart.getChartMetrics that represents the metrics of the chart.

Feedback, Comments & Corrections

CDViewPortManagerMBS.setFullRange(ID as string, minValue as Double, maxValue as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Defines the full range of a view port data scale.
Notes:
In the ChartDirector zooming and scrolling framework, the view port coordinates are expressed as the visible fractions of the "full data scale". For example, if the "full data scale" is 10 years horizontally, a view port width of 0.1 means that 1 year of data are visible.

The setFullRange method defines the full range of a data scale and gives it a name. As ChartDirector supports multiple x-axes and y-axes, so there can be multiple data scales with different names. The name can be used in other ChartDirector APIs to convert between the view port coordinates and data scale (see ViewPortManager.getValueAtViewPort, ViewPortManager.getViewPortAtValue), and to configure an Axis to reflect the visible data scale (see ViewPortManager.syncLinearAxisWithViewPort, ViewPortManager.syncLogAxisWithViewPort and ViewPortManager.syncDateAxisWithViewPort).

ArgumentDefaultDescription
id(Mandatory)The name of the data scale.
minValue(Mandatory)The minimum value of the data scale.
maxValue(Mandatory)The maximum value of the data scale.

Feedback, Comments & Corrections

CDViewPortManagerMBS.setPlotAreaMouseMargin(leftMargin as Integer, rightMargin as Integer, topMargin as Integer, bottomMargin as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 12.3 Yes Yes Yes Yes No
Function: Configures area for mouse tracking.
Notes: SetPlotAreaMouseMargin configures some margins outside the plot area, so that a mouse cursor in that region (and therefore just outside the plot area) will still be considered to be exactly at the boundary of the plot area for the purpose of triggering plot area mouse events. Without this mechanism, it would be difficult to put the mouse exactly at the edge of the plot area (as it is too easy to "overshoot" the edge). Putting the mouse exactly at the edge is very useful for "track cursors" as this tracks the first or last data point.

Feedback, Comments & Corrections

CDViewPortManagerMBS.setViewPortHeight(value as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the height of the view port.
Notes:
The view port height is expressed as a fraction of the height of the underlying surface. It should be between 0 and 1.
ArgumentDefaultDescription
height(Mandatory)The height of the view port.

Feedback, Comments & Corrections

CDViewPortManagerMBS.setViewPortLeft(value as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the position of the left side of the view port.
Notes:
The position of the view port left side is its distance from the left side of the underlying surface, as a fraction of the width of the underlying surface. It should be between 0 and 1.
ArgumentDefaultDescription
left(Mandatory)The position of the left side of the view port.

Feedback, Comments & Corrections

CDViewPortManagerMBS.setViewPortTop(value as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the position of the top side of the view port.
Notes:
The position of the view port top side is its distance from the top side of the underlying surface, as a fraction of the height of the underlying surface. It should be between 0 and 1.
ArgumentDefaultDescription
top(Mandatory)The position of the top side of the view port.

Feedback, Comments & Corrections

CDViewPortManagerMBS.setViewPortWidth(value as Double)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
method ChartDirector MBS ChartDirector Plugin 8.2 Yes Yes Yes Yes No
Function: Sets the width of the view port.
Notes:
The view port width is expressed as a fraction of the width of the underlying surface. It should be between 0 and 1.
ArgumentDefaultDescription
width(Mandatory)The width of the view port.

Feedback, Comments & Corrections

Next items

The items on this page are in the following plugins: MBS ChartDirector Plugin.




Links
MBS Xojo PDF Plugins