# Titanium.Platform.DisplayCaps

> The Display Caps object returned by the [Titanium.Platform.displayCaps](https://titaniumsdk.com/docs/sdk/Titanium.Platform.DisplayCaps.md) property.

- Source: https://titaniumsdk.com/docs/sdk/12.6.3/Titanium.Platform.DisplayCaps
- Titanium SDK version: 12.6.3
- Kind: proxy
- Platforms: Android, iPhone, iPad, macOS
- Since: Titanium SDK 0.8
- Extends: Titanium.Proxy
- Inheritance: Titanium.Proxy

On iPhone and iPod devices with retina display, the `density` property is `high` and the `dpi`
property is `320`. For other iPhone and iPod devices, `density` is `medium` and `dpi` is `160`.

On iPad devices with retina display, the `density` property is `high` and the `dpi`
property is `260`. For other iPad devices, `density` is `medium` and `dpi` is `130`.

Note that Xcode versions prior to 4.3.1 do not have the correct tools to detect the iPad 3
retina display. Apps must be built with Xcode 4.3.1 or later to detect iPad 3 retina display.

Note that the `displayCaps` property begins with a lowercase letter, which differentiates it
from the `DisplayCaps` object that it returns. Refer to the example to understand how it should
be called.

On Android you have to make sure that the Activity is created before you fetch the displayCaps
values. Use the window `onOpen` event or `win.activity.onCreate = () => {};`.

## Example: System Display Information

Output the display properties to the system log.

``` js
Ti.API.info('Ti.Platform.displayCaps.density: ' + Ti.Platform.displayCaps.density);
Ti.API.info('Ti.Platform.displayCaps.dpi: ' + Ti.Platform.displayCaps.dpi);
Ti.API.info('Ti.Platform.displayCaps.platformHeight: ' + Ti.Platform.displayCaps.platformHeight);
Ti.API.info('Ti.Platform.displayCaps.platformWidth: ' + Ti.Platform.displayCaps.platformWidth);
if((Ti.Platform.osname === 'iphone')||(Ti.Platform.osname === 'ipad')||(Ti.Platform.osname === 'android')){
  Ti.API.info('Ti.Platform.displayCaps.logicalDensityFactor: ' + Ti.Platform.displayCaps.logicalDensityFactor);
}
if(Ti.Platform.osname === 'android'){
  Ti.API.info('Ti.Platform.displayCaps.xdpi: ' + Ti.Platform.displayCaps.xdpi);
  Ti.API.info('Ti.Platform.displayCaps.ydpi: ' + Ti.Platform.displayCaps.ydpi);
}
```

## Properties

### density

- Type: String
- Platforms: Android, iPhone, iPad, macOS
- Permission: read-only

Logical density of the display.

### dpi

- Type: Number
- Platforms: Android, iPhone, iPad, macOS
- Permission: read-only

Display density expressed as dots-per-inch.

### logicalDensityFactor

- Type: Number
- Platforms: Android, iPhone, iPad, macOS
- Since: Titanium SDK 3.4.1
- Permission: read-only

Logical density of the display, as a scaling factor for the Density Independent Pixel (dip)
unit.

One dip is one pixel on a 160dpi display, approximately, with a 240x320, 1.5"x2" display
providing a baseline. For example, for a 160dpi display, this value will be 1, and for 120dpi,
it will be .75.

This value does not precisely follow the real display size, as given by `xdpi` and `ydpi`,
but instead is used to scale the size of the overall UI in steps based on changes in the
display dpi. For example, a 240x320 screen will have a density of 1, whether its width is
1.8" or 1.3". However, if the resolution is increased to 320x480 but the display remains
1.5"x2" then the density would be increased to about 1.5.

On iOS devices, this property returns 1, 2 and 3 for @1x, @2x and @3x respectively.
Note for iPhone 6+, this value is 3.

### platformHeight

- Type: Number
- Platforms: Android, iPhone, iPad, macOS
- Permission: read-only

Absolute height of the display in relation to UI orientation. Measured in platform-specific
units; pixels on Android and density-independent pixels (dip) on iOS.

This property depends on the orientation of the UI, rather than the physical orientation of
the device. While these may often be one in the same, it is not necessarily the case when
orientation is restricted by [Titanium.UI.Window.orientationModes](https://titaniumsdk.com/docs/sdk/Titanium.UI.Window.md#orientationModes). See example for
clarification.

Example: Platform Width and Height

Create a window and limit it to portrait mode. Start the app and observe that the platform
width and height is output to the log. Change the physical orientation of the device and
click the window to test again. Note that the logged information relates to the UI rather
than the physical orientation of the device.

``` js
var win = Ti.UI.createWindow({
  title: 'Click window to output UI dimensions',
  backgroundColor: 'white',
  orientationModes: [ Titanium.UI.PORTRAIT ], // UI restricted to portrait mode
  fullscreen: false,
  exitOnClose: true
});

var label = Ti.UI.createLabel({
  text:'Hello world'
});
win.add(label);

function logDisplayCaps(){
  Ti.API.info('Width x Height: ' + Ti.Platform.displayCaps.platformWidth + ' x ' + Ti.Platform.displayCaps.platformHeight);
}

win.addEventListener('click',function(e){
  // as the UI orientation is restricted by orientationModes, this will only ever
  // output the dimensions of the UI in portrait mode. For example, 480 x 800 for the
  // Android device tested
  logDisplayCaps();
});

win.open();

logDisplayCaps();
```

### platformWidth

- Type: Number
- Platforms: Android, iPhone, iPad, macOS
- Permission: read-only

Absolute width of the display in relation to UI orientation. Measured in platform-specific
units; pixels on Android and density-independent pixels (dip) on iOS.

This property depends on the orientation of the UI, rather than the physical orientation of
the device. While these may often be one in the same, it is not necessarily the case when
orientation is restricted by [Titanium.UI.Window.orientationModes](https://titaniumsdk.com/docs/sdk/Titanium.UI.Window.md#orientationModes). See example for
clarification.

Example: Platform Width and Height

Create a window and limit it to portrait mode. Start the app and observe that the platform
width and height is output to the log. Change the physical orientation of the device and
click the window to test again. Note that the logged information relates to the UI rather
than the physical orientation of the device.

``` js
var win = Ti.UI.createWindow({
  title: 'Click window to output UI dimensions',
  backgroundColor: 'white',
  orientationModes: [ Titanium.UI.PORTRAIT ], // UI restricted to portrait mode
  fullscreen: false,
  exitOnClose: true
});

var label = Ti.UI.createLabel({
  text:'Hello world'
});
win.add(label);

function logDisplayCaps(){
  Ti.API.info('Width x Height: ' + Ti.Platform.displayCaps.platformWidth + ' x ' + Ti.Platform.displayCaps.platformHeight);
}

win.addEventListener('click',function(e){
  // as the UI orientation is restricted by orientationModes, this will only ever
  // output the dimensions of the UI in portrait mode. For example, 480 x 800 for the
  // Android device tested
  logDisplayCaps();
});

win.open();

logDisplayCaps();
```

### xdpi

- Type: Number
- Platforms: Android
- Permission: read-only

Physical pixels per inch of the display in the X dimension.

### ydpi

- Type: Number
- Platforms: Android
- Permission: read-only

Physical pixels per inch of the display in the Y dimension.

## Inherited members

7 members are inherited. Each is documented on the type that declares it.

- [Titanium.Proxy](https://titaniumsdk.com/docs/sdk/12.6.3/Titanium.Proxy.md): `addEventListener`, `apiName`, `applyProperties`, `bubbleParent`, `fireEvent`, `lifecycleContainer`, `removeEventListener`

---

- This corpus documents Titanium SDK 13.4.1. Anything here that does not name a version describes 13.4.1.
- Titanium is maintained by TiDev. The Appcelerator toolchain is retired: there is no `appc` CLI, no Appcelerator Studio and no hosted build service. The supported CLI is `titanium` on npm, invoked as `ti`.