DOCSMarshal /JS

$().dmScheduler()

Questo Componente, permette di costruire uno scheduler di DocsMarshal in pagina.

Il seguente codice mostra come costruire il componente passandogli dei parametri ed ottenerne l'istanza per invocare successivamente dei metodi. 

<div id="container"></div>
<script>
// costruisco lo scheduler
    $('#container').dmScheduler({
        ...oggetto contenente i parametri...
    });
// ottengo l'istanza del componente
    let instance = $('#container').dmScheduler('instance');
    ...
// in un secondo momento, ad esempio rispondendo ad un evento, chiamo un metodo del componente
    instance.unlock();
</script>

Elenco parametri

Elenco metodi

Elenco eventi

Descrizione parametri

readOnly

Type: Boolean
Default: false

Permette di definire se lo Scheudler deve essere in sola lettura o meno.

noInsert

Type: Boolean
Default: false

Permette di definire se lo Scheudler deve permettere di effettuare inserimenti di profili o meno.

noUpdate

Type: Boolean
Default: false

Permette di definire se lo Scheudler deve permettere di effettuare modifiche di profili o meno.

noDelete

Type: Boolean
Default: false

Permette di definire se lo Scheudler deve permettere di effettuare eliminazioni di profili o meno.

sessionId

Type: String
Default: null

Permette di definire quale sessione del Portal utilizzare.

height

Type: String
Default: 100%

Permette di definire l'altezza del componente.

initialView

Type: String
Default: "timeline" (se configurata, altrimenti la prima disponibile)

Permette di definire la modalità iniziale di visualizzazione dello Scheduler.

currentDate

Type: DateTime
Default: Data e ora corrente

Permette di definire la data e ora di visualizzazione iniziale dello Scheduler.

timeZone

Type: DateTime
Default: Data e ora corrente

Permette di definire la timezone desiderata.

idScheduler

Type: Guid
Default: null

Permette di definire quale Scheduler di DocsMarshal utilizzare.

externalIdScheduler

Type: String
Default: null

Permette di definire quale Scheduler di DocsMarshal utilizzare.

dynAssId

Type: Guid
Default: null

Permette di definire la DynAss di riferimento come fonte dati dello Scheduler.

dynAssExternalId

Type: String
Default: null

Permette di definire la DynAss di riferimento come fonte dati dello Scheduler.

dynAssObjectIds

Type: String
Default: null

Permette di definire su quali profili applicare la ricerca in DynAss, il parametro chiede l'elenco degli ObjectId di quest'ultimi, separati da ';'.

hideGroupButtons

Type: Boolean
Default: false

Permette di definire se nascondere o meno i bottoni per cambiare la modalità di raggruppamento.

showContentFilters

Type: Boolean
Default: true

Permette di definire se permettere o meno la valorizzazione dei filtri editabili della View del contenuto.

showResourceFilters

Type: Boolean
Default: true

Permette di definire se permettere o meno la valorizzazione dei filtri editabili della View delle risorse.

defaultShowResourcesWithoutContent

Type: Boolean
Default: true

Permette di definire se di default devono essere visualizzate tutte le risorse, anche quelle senza contenuti nell'intervallo selezionato.

contextMenuItems

Type: string[]
Default: ["schedulerMoveTo", "open", "clone", "delete", "split", "new", "newAllDay", "goTo", "repeatAfter", "groups"]

Permette di personalizzare le voci visualizzate alla pressione del tasto destro del mouse sullo scheduler, rimuovendo elementi o aggiungendone alcuni personalizzati.

Descrizione metodi

on

Permette di registrarsi ad un evento mentre lo Scheduler è già in esecuzione.
Richiede un parametro stringa che identifica il nome dell'evento a cui registrarsi.
Vedi eventi

off

Permette di rimuovere l'iscrizione ad un evento mentre lo Scheduler è già in esecuzione.
Richiede un parametro stringa che identifica il nome dell'evento da cui rimuovere l'iscrizione.
Vedi eventi

startLoading

Permette di iniziare un caricamento dello Scheduler.

endLoading

Permette di concludere un caricamento dello Scheduler.
Il caricamento tiene traccia di quante volte è stato invocato e verrà concluso solo quando verrà richiamata la conclusione per ogni singola invocazione.

error

Permette di invocare un errore gestito dallo Scheduler, che si ocuperà di lanciare l'evento onError.

isAttached

Permette di capire se lo Scheduler è ancora presente nel DOM della pagina o meno.

focus

Permette di applicare il focus sullo Scheduler.

dispose

Permette di applicare il dispose dello Scheduler.

repaint

Permette di ricostruire lo Scheduler senza ricaricare i dati.

changeDynAssProfiles

Permette di cambiare i profili in DynAss di riferimento mentre lo Scheduler è già in esecuzione.
Richiede un parametro stringa che identifica l'elenco degli ObjectId dei profili, separati da ';'.

reloadContents

Permette di ricaricare le attività dello Scheduler.

reloadResources

Permette di ricaricare le risorse dello Scheduler.

reload

Permette di ricaricare attività e risorse dello Scheduler.

getStartViewDate

Ritorna data e ora di inzio della visualizzazione corrente dello Scheduler.

getEndViewDate

Ritorna data e ora di inzio della visualizzazione corrente dello Scheduler.

getContents

Ritorna le attività dello Scheduler.

getResources

Ritorna le risorse dello Scheduler.

getScheduler

Ritorna la configurazione DocsMarshal dello Scheduler.

buildContentSearchFilter

Mostra all'utente la schermata di configurazione dei filtri della View delle attività.

buildResourceSearchFilter

Mostra all'utente la schermata di configurazione dei filtri della View delle risorse.

lock

Disabilita le funzionalità di drag e resize delle attività.

unlock

Riabilita le funzionalità di drag e resize delle attività.

getProfiles

Ritorna tutte le attività caricate convertite in DM.Entities.Profile.

getSelectedProfiles

Ritorna tutte le attività selezionate convertite in DM.Entities.Profile.

applySearchText

Permette di effettuare una ricerca client-side sugli appuntamenti dello Scheduler.
La funzione accetta due parametri:

  • valueToSearch (string): valore da cercare
  • searchMode (string): modalità di ricerca, uno tra i valori accettati: [KeepAll, ShowOnlySearched]

Descrizione eventi

contentReady

Questo evento viene invocato quando lo Scheduler ha terminato di costruire il proprio contenuto. Da questo momento in poi il componente è pronto all'utilizzo, ed è concesso accedere a tutte le sue API.

error

Questo evento viene invocato quando lo Scheduler riscontra un errore ed è possibile personalizzarne la visualizzazione dell'utente.
È possibile bloccare la visualizzazione dell'alert di default ritornando false durante l'esecuzione.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • error
    Il messaggio di errore.
  • title
    Il titolo dell'alert che verrà mostrato.
  • icon
    L'icona dell'alert che verrà mostrato.

disposed

Questo evento viene invocato quando lo Scheduler ha concluso il dispose.

contentsLoaded

Questo evento viene invocato quando lo Scheduler ha caricato le proprie attività.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • contents
    Le attività caricate per l'intervallo di visualizzazione corrente.

resourcesLoaded

Questo evento viene invocato quando lo Scheduler ha caricato le proprie risorse.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • resources
    Le risorse caricate.

holidaysLoaded

Questo evento viene invocato quando lo Scheduler ha caricato le proprie festività.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • resources
    Le festività caricate.

appointmentInserting

Questo evento viene invocato subito prima di effettuare l'inserimento di un profilo.
È possibile bloccare l'inserimento del profilo ritornando false durante l'esecuzione.

  • component
    L'istanza del componente.
  • profile
    Il profilo in stato di inserimento.

appointmentInserted

Questo evento viene invocato subito dopo aver effettuato l'inserimento di un profilo.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • appointment
    Il profilo inserito come attività.

appointmentUpdating

Questo evento viene invocato subito prima di effettuare la modifica di un profilo.
È possibile bloccare la modifica del profilo ritornando false durante l'esecuzione.

  • component
    L'istanza del componente.
  • profile
    Il profilo in stato di modifica.

appointmentUpdated

Questo evento viene invocato subito dopo aver effettuato la modifica di un profilo.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • appointment
    Il profilo modificato come attività.

appointmentDeleting

Questo evento viene invocato subito prima di effettuare l'eliminazione di un profilo.
È possibile bloccare la modifica del profilo ritornando false durante l'esecuzione.

  • component
    L'istanza del componente.
  • profile
    Il profilo da eliminare.

appointmentDeleted

Questo evento viene invocato subito dopo aver effettuato l'eliminazione di un profilo.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • appointment
    Il profilo eliminato.

resourceInserted

Questo evento viene invocato subito dopo aver effettuato l'inserimento di una risorsa.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • resource
    Il profilo inserito come risorsa.

resourceUpdated

Questo evento viene invocato subito dopo aver effettuato la modifica di una risorsa.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • resource
    Il profilo modificato come risorsa.

appointmentClick

Questo evento viene invocato subito dopo il click di un'attività.
È possibile bloccare l'apertura del dettaglio del profilo ritornando false durante l'esecuzione.

appointmentDblClick

Questo evento viene invocato subito dopo il doppio click di un'attività.
È possibile bloccare l'apertura del dettaglio del profilo ritornando false durante l'esecuzione.

appointmentSelectionChanged

Questo evento viene invocato subito dopo aver cambiato la selezione delle attività.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • appointments
    Le attività selezionati.

contextMenuPreparing

Questo evento viene invocato alla pressione del tasto destro del mouse.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • data
    I dati specifici relativi alla zona di pressione (cambia a seconda dell'elemento, se cella e appuntamento).
  • items
    Gli elementi che verranno mostrati nel menù, è possibile modificare questo array per personalizzare la visualizzazione.