DashApp (Dash.NET)

Dash.NET

Documentation for 0.2.0-alpha.5

DashApp Type

Namespace: Dash.NET.Giraffe
Assembly: Dash.NET.Giraffe.dll
Base Type: obj
All Interfaces: IEquatable<DashApp> , IStructuralEquatable

Record fields

Record Field	Description
`Callbacks` Full Usage: `Callbacks` Field type: `CallbackMap`	Field type: `CallbackMap`
`Config` Full Usage: `Config` Field type: `DashConfig`	Field type: `DashConfig`
`Index` Full Usage: `Index` Field type: `IndexView`	Field type: `IndexView`
`Layout` Full Usage: `Layout` Field type: `DashComponent`	Field type: `DashComponent`

Static members

Static member	Description
`DashApp.addCallback callback app` Full Usage: `DashApp.addCallback callback app` Parameters: callback : `Callback<'Function>` app : `DashApp` Returns: `DashApp`	Returns a new DashApp with the given callback added to the original Callback register callback : `Callback<'Function>` app : `DashApp` Returns: `DashApp`
`DashApp.addCallbacks callbacks app` Full Usage: `DashApp.addCallbacks callbacks app` Parameters: callbacks : `seq<Callback<'Function>>` app : `DashApp` Returns: `DashApp`	Returns a new DashApp with the given callbacks added to the original Callback register callbacks : `seq<Callback<'Function>>` app : `DashApp` Returns: `DashApp`
`DashApp.appendCSSLinks hrefs app` Full Usage: `DashApp.appendCSSLinks hrefs app` Parameters: hrefs : `seq<string>` app : `DashApp` Returns: `DashApp`	Returns a new DashApp with the given css source links appended to the original IndexView's css register as link tags hrefs : `seq<string>` app : `DashApp` Returns: `DashApp`
`DashApp.appendScripts sources app` Full Usage: `DashApp.appendScripts sources app` Parameters: sources : `seq<string>` app : `DashApp` Returns: `DashApp`	Returns a new DashApp with the given script source links appended to the original IndexView's script register as script tags sources : `seq<string>` app : `DashApp` Returns: `DashApp`
`DashApp.getIndexHTML app` Full Usage: `DashApp.getIndexHTML app` Parameters: app : `DashApp` Returns: `XmlNode`	Returns the given DashApp's index DOM app : `DashApp` Returns: `XmlNode`
`DashApp.initDefault ()` Full Usage: `DashApp.initDefault ()` Returns: `DashApp`	Returns a DashApp with all fields initialized with default values. Returns: `DashApp`
`DashApp.initDefaultWith initializer` Full Usage: `DashApp.initDefaultWith initializer` Parameters: initializer : `DashApp -> DashApp` Returns: `DashApp`	Returns the result of applying an initializer function to a DashApp with all fields initialized with default values. initializer : `DashApp -> DashApp` Returns: `DashApp`
`DashApp.mapIndex mapping app` Full Usage: `DashApp.mapIndex mapping app` Parameters: mapping : `IndexView -> IndexView` app : `DashApp` Returns: `DashApp`	Returns a new DashApp with a new IndexView created by applying the mapping function to the original IndexView. mapping : `IndexView -> IndexView` app : `DashApp` Returns: `DashApp`
`DashApp.run args config app` Full Usage: `DashApp.run args config app` Parameters: args : `string[]` config : `DashGiraffeConfig` app : `DashApp` Returns: `int`	args : `string[]` config : `DashGiraffeConfig` app : `DashApp` Returns: `int`
`DashApp.toHttpHandler app` Full Usage: `DashApp.toHttpHandler app` Parameters: app : `DashApp` Returns: `HttpHandler`	Returns the DasApp as a http handler to use as Giraffe middleware in an asp.netcore pipeline. This application will provide the following endpoints: GET / -> serves the DashApps IndexView (This is also where the Das renderer will render the layout) GET /_dash-layout -> serves the DashApp's layout as JSON GET /_dash-dependencies -> serves the serialized callback handlers registered in the DashApp's callback register as JSON GET /_reload-hash -> Not implemented, returns empty JSON object POST /_dash-update-component -> handles callback requests and returns serialized callback JSON responses. app : `DashApp` Returns: `HttpHandler`
`DashApp.withConfig config app` Full Usage: `DashApp.withConfig config app` Parameters: config : `DashConfig` app : `DashApp` Returns: `DashApp`	Returns a new DashApp with the original DashConfig replaced by the given DashConfig config : `DashConfig` app : `DashApp` Returns: `DashApp`
`DashApp.withIndex index app` Full Usage: `DashApp.withIndex index app` Parameters: index : `IndexView` app : `DashApp` Returns: `DashApp`	Returns a new DashApp with the original IndexView replaced by the given IndexView index : `IndexView` app : `DashApp` Returns: `DashApp`
`DashApp.withLayout layout app` Full Usage: `DashApp.withLayout layout app` Parameters: layout : `DashComponent` app : `DashApp` Returns: `DashApp`	Returns a new DashApp with the original Layout replaced by the given Layout layout : `DashComponent` app : `DashApp` Returns: `DashApp`