Class # MobileChart --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description Displays data you provide in chart form of various types. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |--------------------------------------------------------------|---------------------------------------------------|-----------|--------| | `AccessibilityHint` | `String` | | | | `AccessibilityLabel` | `String` | | | | `AllowPopover` | `Boolean` | | | | `AutoCalculateYAxis` | `Boolean` | | | | `Backdrop` | `Picture` | | | | `BackgroundColor` | `ColorGroup` | | | | `ControlCount` | `Integer` | ✓ | | | `DatasetCount` | `Integer` | ✓ | | | `DatasetLastIndex` | `Integer` | ✓ | | | `Enabled` | `Boolean` | | | | `Format` | `String` | | | | `GridColor` | `ColorGroup` | | | | `HasAnimation` | `Boolean` | | | | `HasLegend` | `Boolean` | | | | `Height` | `Integer` | ✓ | | | `IsGridVisible` | `Boolean` | | | | `IsYAxisVisible` | `Boolean` | | | | `IsXAxisVisible` | `Boolean` | | | | `LabelCount` | `Integer` | ✓ | | | `LabelLastIndex` | `Integer` | ✓ | | | `Left` | `Integer` | ✓ | | | `LegendColor` | `ColorGroup` | | | | `LegendFont` | `Font` | | | | `LegendFontSize` | `Double` | | | | `LockBottom` | `Boolean` | ✓ | | | `LockLeft` | `Boolean` | ✓ | | | `LockRight` | `Boolean` | ✓ | | | `LockTop` | `Boolean` | ✓ | | | `Mode` | `Modes` | ✓ | | | `Name` | `String` | ✓ | | | `Parent` | `Object` | ✓ | | | `PopoverBackgroundColor` | `ColorGroup` | | | | `PopoverTextColor` | `ColorGroup` | | | | `TabIndex` | `Integer` | | | | `TextColor` | `ColorGroup` | | | | `TextFont` | `Font` | | | | `TintColor` | `ColorGroup` | | | | `Title` | `String` | | | | `TitleColor` | `ColorGroup` | | | | `TitleFont` | `Font` | | | | `TitleFontSize` | `Double` | | | | `Tooltip` | `String` | | | | `Top` | `Integer` | ✓ | | | `Visible` | `Boolean` | | | | `Width` | `Integer` | ✓ | | ## Methods

table-centered_column_4

| Name | Parameters | Returns | Shared | |----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|--------| | `AddConstraint` | constraint As `iOSLayoutConstraint`, name As `String` = "" | | | | `AddControl` | child As `MobileUIControl`, isBeingAdded As `Boolean` = `False` | | | | `AddDataset` | dataset As `ChartDataset` | | | | `AddDatasetAt` | index As `Integer`, Dataset As `ChartDataset` | | | | `AddDatasets` | Datasets() As `ChartDataset` | | | | `AddLabel` | name As `String` | | | | `AddLabelAt` | index As `String`, name As `String` | | | | `AddLabels` | names() As `String` | | | | `ClearFocus` | | | | | `Constraint` | name As `String` | `iOSLayoutConstraint` | | | `DatasetAt` | index As `Integer` | `ChartDataset` | | | `Datasets` | | `Iterable` | | | `Handle` | | `Ptr` | | | `LabelAt` | index As `Integer` | `String` | | | `Labels` | | `Iterable` | | | `Refresh` | | | | | `RemoveAllDatasets` | | | | | `RemoveAllLabels` | | | | | `RemoveConstraint` | constraint As `iOSLayoutConstraint` | | | | | name As `String` | | | | `RemoveControl` | child As `MobileUIControl` | | | | `RemoveDatasetAt` | index As `Integer` | | | | `RemoveLabelAt` | index As `Integer` | | | | `SetFocus` | | | | | `ToPicture` | width As `Double` = -1, height As `Double` = -1 | `Picture` | | | | width As `Double` = -1, height As `Double` = -1 | | | ## Events

table-centered_column_4

| Name | Parameters | Returns | |----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|---------| | `AppearanceChanged` | dark As `Boolean` | | | `Closing` | | | | `Error` | DataSet As `ChartDataSet` | | | `Opening` | | | | `PointerDrag` | position As `Point`, pointerInfo() As `PointerEvent` | | | `PointerUp` | position As `Point`, pointerInfo() As `PointerEvent` | | | `Pressed` | dataset As `ChartDataset`, index As `Integer` | | | `RequestedPicture` | chart As `Picture` | | ## Enumerations

forsearch

MobileChart.Modes ### Modes > The various types of charts available. > > | Enum | > |-----------| > | Bar | > | Bubble | > | Doughnut | > | Line | > | Pie | > | PolarArea | > | Radar | > | Scatter | > | Stacked | ## Property descriptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

MobileChart.AccessibilityHint **AccessibilityHint** As `String` > The accessibility hint is a longer description that is read aloud when VoiceOver is enabled. > > ``` xojo > Me.AccessibilityHint = "Click to calculate the value and display the next screen." > ``` > >

> >

> > Important > >

> > This property is not currently supported for Android. > >

forsearch

MobileChart.AccessibilityLabel **AccessibilityLabel** As `String` > The accessibility label of of a control is a short name that is read aloud when VoiceOver is enabled. > > ``` xojo > Me.AccessibilityLabel = "Calculate the value." > ```

forsearch

MobileChart.AllowPopover **AllowPopover** As `Boolean` > If `True`, a popover will be displayed when the user positions the mouse over items that have additional information. > > The default value is `True`.

forsearch

MobileChart.AutoCalculateYAxis **AutoCalculateYAxis** As `Boolean` > If `False`, the Y axis for Line and Bar charts will start at 0. > > This property is `True` by default.

forsearch

MobileChart.Backdrop **Backdrop** As `Picture` > The passed `Picture` that will automatically be drawn behind the chart data. > > The following code assigns a jpg image to the Backdrop. The image has been added to the project. The code is in the Opening event. > > ``` xojo > Me.BackDrop = HouseImage > ```

forsearch

MobileChart.BackgroundColor **BackgroundColor** As `ColorGroup` > The color of the background of the chart.

forsearch

MobileChart.ControlCount **ControlCount** As `Integer` > The number of child controls in the control. > > This property is read-only. > >

> >

> > Important > >

> > This property is supported for iOS only. > >

forsearch

MobileChart.DatasetCount **DatasetCount** As `Integer` > The number of datasets that have been added to the chart. > > This property is read-only.

forsearch

MobileChart.DatasetLastIndex **DatasetLastIndex** As `Integer` > The index of last dataset added to the chart. > > This property is read-only.

forsearch

MobileChart.Enabled **Enabled** As `Boolean` > When `True` the control is drawn enabled and responds to user action. When `False`, the control appears as disabled and does not respond to user actions.

forsearch

MobileChart.Format **Format** As `String` > Used to format axis values. > > It uses the same formatting conventions as the `Format` function.

forsearch

MobileChart.GridColor **GridColor** As `ColorGroup` > The color of the chart's grid.

forsearch

MobileChart.HasAnimation **HasAnimation** As `Boolean` > If `True`, changes to chart data will result in animated updates to the chart. > >

> >

> > Important > >

> > This property is not supported for iOS. > >

forsearch

MobileChart.HasLegend **HasLegend** As `Boolean` > If `True`, the chart's legend will be displayed.

forsearch

MobileChart.Height **Height** As `Integer` > The height of the control. > > This property is read-only on iOS.

forsearch

MobileChart.IsGridVisible **IsGridVisible** As `Boolean` > Determines if the grid will be drawn or not.

forsearch

MobileChart.IsYAxisVisible **IsYAxisVisible** As `Boolean` > Determines if the Y axis will be drawn or not.

forsearch

MobileChart.IsXAxisVisible **IsXAxisVisible** As `Boolean` > Determines if the X axis will be drawn or not.

forsearch

MobileChart.LabelCount **LabelCount** As `Integer` > The number of labels in the chart. > > This property is read-only.

forsearch

MobileChart.LabelLastIndex **LabelLastIndex** As `Integer` > The index of last label added to the chart. > > This property is read-only.

forsearch

MobileChart.Left **Left** As `Integer` > The position of the left side of the control, relative to the screen. > > This property is read-only on iOS.

forsearch

MobileChart.LegendColor **LegendColor** As `ColorGroup` > Gets or sets the color of the legend. The default value is black. > > The following example sets the LegendColor. > > ``` xojo > Me.LegendColor = Color.Red > ```

forsearch

MobileChart.LegendFont **LegendFont** As `Font` > Name of the font used to display the chart legend. > > You can enter any font that is installed in the browser or the names of the two metafonts, "System" and "SmallSystem". > > This code sets the LegendFont property. > > ``` xojo > Me.LegendFont = New Font("Helvetica", 24) > ```

forsearch

MobileChart.LegendFontSize **LegendFontSize** As `Double` > Point size of the font used to display the legend. > > If you enter zero as the FontSize, your app will use the font size that works best for the platform on which it is running. > > This code sets the font size to 16 points. > > ``` xojo > Me.LegendFontSize = 16 > ```

forsearch

MobileChart.LockBottom **LockBottom** As `Boolean` > Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning screen. > > This property is read-only.

forsearch

MobileChart.LockLeft **LockLeft** As `Boolean` > Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning screen. > > This property is read-only.

forsearch

MobileChart.LockRight **LockRight** As `Boolean` > Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning screen. > > This property is read-only.

forsearch

MobileChart.LockTop **LockTop** As `Boolean` > Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning screen. > > This property is read-only.

forsearch

MobileChart.Mode **Mode** As `Modes` > Indicates the type of chart the control is currently displaying. > > This property is read-only. > > Labels are required for a Bar chart to draw. > > This example checks the mode of the chart: > > ``` xojo > If Chart1.Mode = MobileChart.Modes.Bar then > Chart1.Title = "Sales Bar Chart" > End If > ```

forsearch

MobileChart.Name **Name** As `String` > The name of the control. > > This property is read-only.

forsearch

MobileChart.Parent **Parent** As `Object` > Used to get the control's parent control or page. If the parent control is a `MobileContainer`, then it returns the `MobileContainer`. If it is on a `Screen`, it returns the `Screen`. > > This property is read-only.

forsearch

MobileChart.PopoverBackgroundColor **PopoverBackgroundColor** As `ColorGroup` > The background color of the chart's popover.

forsearch

MobileChart.PopoverTextColor **PopoverTextColor** As `ColorGroup` > The color of text in the chart's popover.

forsearch

MobileChart.TabIndex **TabIndex** As `Integer` > The control's position in the Tab Order. The control with a TabIndex of 0 is the first control to get the focus when the Screen is displayed. > > This example sets the control's TabIndex. > > ``` xojo > Me.TabIndex = 2 > ```

forsearch

Mobilechart.TextColor **TextColor** As `ColorGroup` > Gets or sets the color of the text. The default value is black. > > The following example sets the TextColor. > > ``` xojo > Me.TextColor = Color.Red > ```

forsearch

MobileChart.TextFont **TextFont** As `Font` > The font used to display the text content. > > You can use any font that is installed on the device. > > The System font is the font used by the system software as its default font. Different operating systems use different default fonts. If the system software supports both a large and small System font, you can also specify the "SmallSystem" font. > > On iOS, *SmallSystem* specifies the smaller system font. > > This code sets the TextFont property to the System font. > > ``` xojo > Me.TextFont = Font.SystemFont > ```

forsearch

MobileChart.TintColor **TintColor** As `ColorGroup` > Changes a control's tint color. > >

> >

> > Important > >

> > This is supported for iOS only. > >

> > On iOS, the following controls support TintColor: > > | Enum | Description | > |-------------|------------------------------------------------------------------------------| > | PopupMenu | The background color will be drawn in the TintColor. | > | ProgressBar | The area indicating the value of the control will be drawn in the TintColor. | > | Slider | The area indicating the value of the control will be drawn in the TintColor. | > | TextArea | The cursor and text highlight color will be drawn in the TintColor. | > | TextField | The cursor and text highlight color will be drawn in the TintColor. |

forsearch

MobileChart.Title **Title** As `String` > The title of the chart.

forsearch

MobileChart.TitleColor **TitleColor** As `ColorGroup` > Gets or sets the color of the title. The default value is black. > > The following example sets the TitleColor. > > ``` xojo > Me.TitleColor = Color.Red > ```

forsearch

MobileChart.TitleFont **TitleFont** As `Font` > Name of the font used to display the chart title. > > You can enter any font that is installed in the browser or the names of the two metafonts, "System" and "SmallSystem". > > This code sets the TitleFont property. > > ``` xojo > Me.TitleFont = New Font("Helvetica", 24) > ```

forsearch

MobileChart.TitleFontSize **TitleFontSize** As `Double` > Point size of the font used to display the title. > > If you enter zero as the FontSize, your app will use the font size that works best for the platform on which it is running. > > This code sets the font size to 16 points. > > ``` xojo > Me.TitleFontSize = 16 > ```

forsearch

MobileChart.Tooltip **Tooltip** As `String` > Text of a message displayed as a tooltip. > > The tip is displayed when the user places the mouse on the control and leaves it there. > > This code in the Opening event of a Button sets the tooltip: > > ``` xojo > Me.Tooltip = "Save changes" > ```

forsearch

MobileChart.Top **Top** As `Integer` > The top of the control in local coordinates relative to the Screen. > > This property is read-only on iOS.

forsearch

MobileChart.Visible **Visible** As `Boolean` > If `True`, the control is drawn. If `False`, it's not. > > Hide a control based on a checkbox setting: > > ``` xojo > If ShowEmailCheckbox.Value Then > EmailField.Visible = True > Else > EmailField.Visible = False > End If > ```

forsearch

MobileChart.Width **Width** As `Integer` > The width of the control. > > This property is read-only on iOS. > > This code in the Opening event handler increases the size of the control: > > ``` xojo > Me.Width = Me.Width + 50 > ``` ## Method descriptions

forsearch

MobileChart.AddConstraint **AddConstraint**(constraint As `iOSLayoutConstraint`, name As `String` = "") > Adds a *constraint* to the control. The optional *name* parameter can be used to `remove a constraint` that was added via code. > > This *constraint* is used by child controls that have been added to this control. > >

> >

> > Important > >

> > This is supported for iOS only. > >

forsearch

MobileChart.AddControl **AddControl**(child As `MobileUIControl`, isBeingAdded As `Boolean` = `False`) > Adds a *child* control to the control. When the value of *isBeingAdded* is `True`, the Opening event is triggered for the child control being added. > >

> >

> > Important > >

> > This is supported for iOS only. > >

forsearch

MobileChart.AddDataset **AddDataset**(dataset As `ChartDataset`) > Adds the *dataset* to the chart. Incompatible datasets are ignored.

forsearch

MobileChart.AddDatasetAt **AddDatasetAt**(index As `Integer`, dataset As `ChartDataset`) > Adds the *dataset* to the chart at the *index* passed. Incompatible datasets are ignored.

forsearch

MobileChart.AddDatasets **AddDatasets**(datasets() As `ChartDataset`) > Adds the array of *datasets* to the chart.

forsearch

MobileChart.AddLabel **AddLabel**(name As `String`) > Adds the label to the chart.

forsearch

MobileChart.AddLabelAt **AddLabelAt**(index As `String`, name As `String`) > Adds the label to the chart at the *index* passed.

forsearch

MobileChart.AddLabels **AddLabels**(names() As `String`) > Adds the array of labels to the chart.

forsearch

MobileChart.ClearFocus **ClearFocus** > Removes the focus from the control. > > ``` xojo > TextField1.ClearFocus > ```

forsearch

MobileChart.Constraint **Constraint**(name As `String`) As `iOSLayoutConstraint` > Gets a reference to a named constraint so that you can modify its settings in code. > >

> >

> > Important > >

> > This is supported for iOS only. > >

> > Change an existing (and named) constraint of a control on the Screen: > > ``` xojo > ' "TAWidth" is a width constraint for a TextField that has been given > ' a name in the auto-layout Inspector properties. > Var c As iOSLayoutConstraint = Self.Constraint("TAWidth") > c.Offset = 200 > ```

forsearch

MobileChart.ControlAt **ControlAt**(index As `Integer`) As MobileUIControl > Gets the child control at the specified *index*. > >

> >

> > Important > >

> > This is supported for iOS only. > >

forsearch

MobileChart.Controls **Controls** As `Iterable` > Allows you to iterate through all the controls that have been added to this control. > >

> >

> > Important > >

> > This is supported for iOS only. > >

forsearch

MobileChart.DatasetAt **DatasetAt**(index As `Integer`) As `ChartDataset` > Returns the `ChartDataset` at the *index* passed.

forsearch

MobileChart.Datasets **Datasets**() As `Iterable` > Allows iterating through all data sets.

forsearch

MobileChart.Handle **Handle** As `Ptr` > The handle to the underlying native OS control. > >

> >

> > Important > >

> > This is supported for iOS only. > >

forsearch

MobileChart.LabelAt **LabelAt**(index As `Integer`) As `String` > Returns the label at the *index* passed.

forsearch

MobileChart.Labels **Labels**() As `Iterable` > Allows iterating through all labels.

forsearch

MobileChart.Refresh **Refresh** > Marks the control so that it will be redrawn during the next event loop. > > Call Refresh to force a Canvas to redraw itself: > > ``` xojo > Canvas1.Refresh > ```

forsearch

MobileChart.RemoveAllDatasets **RemoveAllDatasets** > Removes all datasets from the chart.

forsearch

MobileChart.RemoveAllLabels **RemoveAllLabels** > Removes all labels from the chart.

forsearch

MobileChart.RemoveConstraint **RemoveConstraint**(constraint As `iOSLayoutConstraint`) > Removes a *constraint* from the control. > >

> >

> > Important > >

> > This is supported for iOS only. > >

> >

> > Important > >

> > This is supported for iOS only. > >

forsearch

MobileChart.RemoveControl **RemoveControl**(child As `MobileUIControl`) > Removes the control from the control. > >

> >

> > Important > >

> > This is supported for iOS only. > >

forsearch

MobileChart.RemoveDatasetAt **RemoveDatasetAt**(index As `Integer`) > Removes the `ChartDataset` at the *index* passed.

forsearch

MobileChart.RemoveLabelAt **RemoveLabelAt**(index As `Integer`) > Removes the label at the *index* passed.

forsearch

MobileChart.SetFocus **SetFocus** > Sets the focus to the MobileChart control.

forsearch

MobileChart.ToPicture **ToPicture**(width As `Double` = -1, height As `Double` = -1) As `Picture` > Returns the chart as a `Picture` at the size specified by the *width* and *height* parameters. If these parameters are not specified, the `Picture` is created using the dimensions of the chart. > >

> >

> > Important > >

> > This method is not supported for Android. > >

**ToPicture**(width As `Double` = -1, height As `Double` = -1) > Creates a `Picture` from the the chart at the size specified by the *width* and *height* parameters. If these parameters are not specified, the `Picture` is created using the dimensions of the chart. The `Picture` is returned via the `RequestedPicture` event. > >

> >

> > Important > >

> > This method is not supported for iOS. > >

## Event descriptions

forsearch

MobileChart.AppearanceChanged **AppearanceChanged**(dark As `Boolean`) > If *dark* is `True` then the device has switched to Dark mode. If `False` then the device has switched to Light mode.

forsearch

MobileChart.Closing **Closing** > The control is about to be removed from the Screen either because the Screen is closing or the control's Close method was called.

forsearch

MobileChart.Error **Error**(DataSet As `ChartDataSet`) > The chart either has no room to display the data or is too small to draw the grid. The *DataSet* is the `ChartDataSet` assigned to the control.

forsearch

MobileChart.Opening **Opening** > The control has been created and the page is opening but has not been sent to the browser yet. > > The Opening event handler can be used to initialize non-visual properties and settings for controls.

forsearch

MobileChart.PointerDrag **PointerDrag**(position As `Point`, pointerInfo() As `PointerEvent`) > Called when the pointing device (finger or pen) is dragged. > >

> >

> > Important > >

> > This event is not supported for Android. > >

forsearch

MobileChart.PointerUp **PointerUp**(position As `Point`, pointerInfo() As `PointerEvent`) > Called when the pointing device (finger or pen) is raised or released. > >

> >

> > Important > >

> > This event is not supported for Android. > >

forsearch

MobileChart.Pressed **Pressed**(dataset As `ChartDataset`, index As `Integer`) > The user pressed on a part of the chart that represents data from the *dataset*.

forsearch

MobileChart.RequestedPicture **RequestedPicture**(chart As `Picture`) > This event is called when the `ToPicture` method and is passed a `Picture` representing the chart. > >

> >

> > Important > >

> > This event is not supported for iOS. > >

## Compatibility | | | |-----------------------|--------| | **Project Types** | Mobile | | **Operating Systems** | All |

`MobileCanvas` parent class; `ChartCircularDataset`, `ChartDataset`, `ChartLinearDataset` and `ChartScatterDatapoint` classes.