@nativescript/core
Version:
A JavaScript library providing an easy to use api for interacting with iOS and Android platform APIs.
105 lines (90 loc) • 2.59 kB
TypeScript
/**
* Contains the FormattedString and Span classes, which are used to create a formatted (rich text) strings.
*/
import { Span } from './span';
import { ObservableArray } from '../../data/observable-array';
import { ViewBase } from '../core/view-base';
import { Color } from '../../color';
import { FontStyleType, FontVariationSettingsType, FontWeightType } from '../styling/font';
import { CoreTypes } from '../../core-types';
/**
* A class used to create a formatted (rich text) string.
*
* @nsView FormattedString
*/
export class FormattedString extends ViewBase {
/**
* An observable collection of Span objects used to define common text properties.
*/
public spans: ObservableArray<Span>;
/**
* A human readable representation of the formatted string.
*/
public toString(): string;
/**
* Gets or sets the font family which will be used for all spans that doesn't have a specific value.
*
* @nsProperty
*/
public fontFamily: string;
/**
* Gets or sets the font size which will be used for all spans that doesn't have a specific value.
*
* @nsProperty
*/
public fontSize: number;
/**
* Gets or sets the font style which will be used for all spans that doesn't have a specific value.
*
* @nsProperty
*/
public fontStyle: FontStyleType;
/**
* Gets or sets the font weight which will be used for all spans that doesn't have a specific value.
*
* @nsProperty
*/
public fontWeight: FontWeightType;
/**
* Gets or sets the font variation settings which will be used for all spans that doesn't have a specific value.
*
* @nsProperty
*/
public fontVariationSettings: FontVariationSettingsType[];
/**
* Gets or sets text decorations which will be used for all spans that doesn't have a specific value.
*
* @nsProperty
*/
public textDecoration: CoreTypes.TextDecorationType;
/**
* Gets or sets the font foreground color which will be used for all spans that doesn't have a specific value.
*
* @nsProperty
*/
public color: Color;
/**
* Gets or sets the font background color which will be used for all spans that doesn't have a specific value.
*
* @nsProperty
*/
public backgroundColor: Color;
/**
* Defines whether accessibility font scale should affect font size.
*
* @nsProperty
*/
iosAccessibilityAdjustsFontSize: boolean;
/**
* Gets or sets the minimum accessibility font scale.
*
* @nsProperty
*/
iosAccessibilityMinFontScale: number;
/**
* Gets or sets the maximum accessibility font scale.
*
* @nsProperty
*/
iosAccessibilityMaxFontScale: number;
}