Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Expand Up @@ -29,20 +29,20 @@ var runtimeOptions = new Openfin.Desktop.RuntimeOptions
};
```

###Application Options
### Application Options
The Application Options object allows you to configure the OpenFin Application being embedded, options include: name, URL, icon and window options, you can read more about options in our [Docs](https://openfin.co/developers/application-config/):
```js
var appOptions = new Openfin.Desktop.ApplicationOptions("of-chart",
"of-chart-uuid", "http://cdn.openfin.co/embed-web/chart.html");
```

###Initialize
### Initialize
The EmbeddedView needs to be initialized with both the RuntimeOptions object and the ApplicationOptions object:
```js
OpenFinEmbeddedView.Initialize(runtimeOptions, appOptions);
```

###Ready
### Ready
To programmatically react to when the EmbeddedView has loaded its content, initialized and is ready to be displayed you can subscribe to the Ready event:
```js
OpenFinEmbeddedView.Ready += (sender, e) =>
Expand All @@ -53,7 +53,7 @@ OpenFinEmbeddedView.Ready += (sender, e) =>
}
```

###Embedding Child Windows
### Embedding Child Windows
The OpenFinEmbeddedView allows you to embed web applicatons, these have their own render process and sandbox, but it also allows you to embed child windows that can share the same render process and sandbox, adding the risk of one window crashing the other but using less resources.
```js
OpenFinEmbeddedView.Ready += (sender, e) =>
Expand All @@ -66,7 +66,7 @@ OpenFinEmbeddedView.Ready += (sender, e) =>
}
```

###Runtime Object
### Runtime Object
Every EmbeddedView control that shares a RuntimeOptions object will share a connection to the OpenFin Runtime. You can obtain this singleton object via the Runtime.GetRuntimeInstance function. It allows you to publish and subscribe to Inter Application Bus messages, react to disconnect events, and initiate connect calls (this is optional and unnecessary in the case where one or more EmbeddedView control has been initialized).
```js
var openFinRuntime = Runtime.GetRuntimeInstance(runtimeOptions);
Expand Down