TimelineSpan - Global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 10 min. de leitura

    • A API TimelineSpan fornece métodos para definir um conjunto de propriedades que descrevem as características e o comportamento interativo de um elemento renderizado em um item de linha do tempo.

    Como é extremamente importante que toda a coleção de períodos de um item de linha do tempo seja exclusiva, a criação de uma nova instância deve ser realizada usando o método createTimelineItem() de uma instância de item de linha do tempo existente.

    TimelineSpan - addPredecessor(matriz de objetos objArray)

    Adiciona vários relacionamentos entre a instância atual e outros objetos TimelineSpan enumerando por meio da matriz de objetos JavaScript.

    Cada objeto deve ter uma propriedade interna relationship_sys_id e predecessor_sys_id especificada.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    objArray Matriz de objetos Matriz de objetos JavaScript que contém duas propriedades internas: relationship_sys_id e predecessor_sys_id.
    Tabela 2. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - addPredecessor(cadeia de caracteres strPredecessorSysId, cadeia de caracteres strRelationshipSysId, cadeia de caracteres strTableName)

    Adiciona o relacionamento especificado entre a instância atual e outro TimelineSpan e permite que o relacionamento abra um GlideWindow para exibir informações sobre o relacionamento.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    strPredecessorSysId Cadeia de caracteres Sys_id do registro de tarefa planejada que é o predecessor do relacionamento.
    strRelationshipSysId Cadeia de caracteres Sys_id do registro de relacionamento do relacionamento.
    strTableName Cadeia de caracteres Nome da tabela para o relacionamento.
    Tabela 4. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - addPredecessor(cadeia de caracteres strPredecessorSysId, cadeia de caracteres strRelationshipSysId)

    Adiciona o relacionamento especificado entre a instância atual e outro período de linha do tempo com sys_id strPredecessorSysId.

    A linha desenhada não terá nenhum manipulador de clique duplo associado a ela.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    strPredecessorSysId Cadeia de caracteres Sys_id do registro de tarefa planejada que é o predecessor do relacionamento.
    strRelationshipSysId Cadeia de caracteres Sys_id do registro de relacionamento do relacionamento.
    Tabela 6. Retorna
    Tipo Descrição
    vazio

    TimelineSpan – getAllowXDragLeft()

    Retorna o valor booliano da propriedade AllowXDragLeft.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se a hora de início do objeto pode ser ajustada.
    Valores válidos:
    • verdadeiro: a hora de início do objeto pode ser ajustada.
    • falso: a hora de início do objeto não pode ser ajustada.

    TimelineSpan – getAllowXDragRight()

    Retorna o valor booliano da propriedade AllowXDragRight.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se a hora de término do objeto pode ser ajustada.
    Valores válidos:
    • verdadeiro: a hora de término do objeto pode ser ajustada.
    • falso: a hora de término do objeto não pode ser ajustada.

    TimelineSpan - getAllowXMove()

    Retorna o valor booliano da propriedade AllowXMove.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 12. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se o objeto pode ser movido horizontalmente.
    Valores válidos:
    • verdadeiro: o objeto pode ser movido horizontalmente.
    • falso: o objeto não pode ser movido horizontalmente.

    TimelineSpan - getAllowYMove()

    Retorna o valor booliano da propriedade AllowYMove.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 14. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se o objeto pode ser movido verticalmente.
    Valores válidos:
    • verdadeiro: o objeto pode ser movido verticalmente.
    • falso: o objeto não pode ser movido verticalmente.

    TimelineSpan – getAllowYMovePredecessor()

    Retorna o valor booliano da propriedade AllowYMovePredecessor.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 16. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se uma linha de relacionamento tracejada pode ser desenhada do objeto atual para um novo sucessor.
    Valores válidos:
    • verdadeiro: a linha de relacionamento tracejada pode ser desenhada do objeto atual para um novo sucessor.
    • falso: a linha de relacionamento tracejada não pode ser desenhada do objeto atual para um novo sucessor.

    TimelineSpan – getInnerSegmentClass()

    Retorna o nome da classe de segmento interno atual para o período da linha do tempo.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 18. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome da classe para o estilo de segmento interno atual.

    TimelineSpan – getInnerSegmentEndTimeMs()

    Retorna o tempo em milissegundos da hora de término da parte do segmento interno do período da linha do tempo.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 20. Retorna
    Tipo Descrição
    Número Hora de término da parte do segmento interno do período da linha do tempo.

    Unidade: Milissegundos

    TimelineSpan – getInnerSegmentStartTimeMs()

    Retorna o tempo em milissegundos da hora de início da parte do segmento interno do período da linha do tempo.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 22. Retorna
    Tipo Descrição
    Número Hora de início da parte do segmento interno do período da linha do tempo.

    Unidade: Milissegundos

    TimelineSpan – getIsChanged()

    Retorna um booliano que especifica se o item da linha do tempo atual foi modificado ou não após a inicialização.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 24. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se o período atual foi marcado como alterado.
    Valores válidos:
    • verdadeiro: marcado como alterado.
    • falso: não marcado como alterado.

    TimelineSpan – getPointIconClass()

    Retorna uma cadeia de caracteres que especifica o nome da classe de ícone a ser usada para exibir o elemento na linha do tempo se a instância atual tiver duração zero.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 26. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome da classe de ícone a ser usada para exibir o período da linha do tempo atual se a duração for zero.

    TimelineSpan – getPredecessors()

    Retorna uma matriz de todos os objetos predecessores associados à instância atual. Cada objeto de matriz é um HashMap que contém uma propriedade predecessor_sys_id e related_sys_id.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 28. Retorna
    Tipo Descrição
    Matriz de objetos Lista de HashMaps que contém duas propriedades internas: predecessor_sys_id e relacionamento_sys_id.

    TimelineSpan - getSpanColor()

    Retorna o nome da cadeia de caracteres da cor de fundo especificada para exibir este período.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 30. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome da cor HTML a ser usada como cor de fundo do elemento.

    TimelineSpan - getSpanText()

    Retorna a cadeia de caracteres que especifica o texto a ser exibido ao lado do elemento de tempo.

    Nota:
    Este texto só será exibido se o objeto GlideTimeline tiver habilitado o texto da linha do tempo definido usando o método glideTimeline.showTimelineText(true).
    Tabela 31. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 32. Retorna
    Tipo Descrição
    Cadeia de caracteres Texto exibido ao lado do elemento.

    TimelineSpan - getStartTimeMs()

    Retorna a hora de início em milissegundos do objeto TimelineSpan atual.

    Tabela 33. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 34. Retorna
    Tipo Descrição
    Número Hora de início do elemento.

    Unidade: Milissegundos

    TimelineSpan – getSysId()

    Retorna o sys_id do objeto atual.

    Este método é útil para retornar o sys_id quando a instância do objeto atual foi criada sem um sys_id específico para obter o GUID gerado dinamicamente.

    Tabela 35. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 36. Retorna
    Tipo Descrição
    Cadeia de caracteres sys_id exclusivo do elemento atual.

    TimelineSpan – getTable()

    Retorna o nome da tabela em que o sys_id é referenciado.

    Tabela 37. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 38. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome da tabela.

    TimelineSpan - getTooltip()

    Retorna o texto/html a ser exibido na dica da ferramenta quando o elemento TimelineSpan estiver sendo passado o mouse.

    Tabela 39. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 40. Retorna
    Tipo Descrição
    Cadeia de caracteres Texto da dica da ferramenta.

    TimelineSpan – setAllowXDragLeft(Booliano bFlag)

    Define um sinalizador que determina se a data de início do elemento pode ser arrastada para a esquerda ou para a direita, ajustando assim a duração da tarefa.

    O efeito desse comportamento é controlado pela inclusão de script que lida com o evento apropriado. O valor padrão desta propriedade é falso.

    Tabela 41. Parâmetros
    Nome Tipo Descrição
    bFlag Booliano Sinalizador que indica se a data de início do elemento pode ser ajustada.
    Valores válidos:
    • verdadeiro: a data de início pode ser ajustada.
    • falso: a data de início não pode ser ajustada.
    Tabela 42. Retorna
    Tipo Descrição
    vazio

    TimelineSpan – setAllowXDragRight(Booliano bFlag)

    Define um sinalizador que determina se a data de término do elemento pode ser arrastada para a esquerda ou para a direita, ajustando assim a duração da tarefa.

    O efeito desse comportamento é controlado pela inclusão de script que lida com o evento apropriado. O valor padrão desta propriedade é falso.

    Tabela 43. Parâmetros
    Nome Tipo Descrição
    bFlag Booliano Sinalizador que indica se a data de término do elemento pode ser ajustada.
    Valores válidos:
    • verdadeiro: a data de término pode ser ajustada.
    • falso: a data de término não pode ser ajustada.
    Tabela 44. Retorna
    Tipo Descrição
    vazio

    TimelineSpan – setAllowXMove(Boolean bFlag )

    Define um sinalizador que determina se o elemento pode ser movido para iniciar em um momento diferente.

    O efeito desse comportamento é controlado pela inclusão de script que lida com o evento apropriado. O valor padrão desta propriedade é falso.

    Tabela 45. Parâmetros
    Nome Tipo Descrição
    bFlag Booliano Sinalizador que indica se o elemento pode ser movido horizontalmente.
    Valores válidos:
    • verdadeiro: o elemento pode ser movido horizontalmente.
    • falso: o elemento não pode ser movido horizontalmente.
    Tabela 46. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - setAllowYMove(Boolean bFlag )

    Define um sinalizador que determina se o elemento pode ser arrastado verticalmente na linha do tempo.

    O efeito desse comportamento é controlado pela inclusão de script que lida com o evento apropriado. O valor padrão desta propriedade é falso.

    Tabela 47. Parâmetros
    Nome Tipo Descrição
    bFlag Booliano Sinalizador que indica se o elemento pode ser movido verticalmente.
    Valores válidos:
    • verdadeiro: o elemento pode ser movido verticalmente.
    • falso: o elemento não pode ser movido verticalmente.
    Tabela 48. Retorna
    Tipo Descrição
    vazio

    TimelineSpan – setAllowYMovePredecessor(Booliano bFlag)

    Define um sinalizador que determina se uma linha de relacionamento tracejada pode ser desenhada a partir deste elemento interativamente na linha do tempo.

    O efeito desse comportamento é controlado pela inclusão de script que lida com o evento apropriado. O valor padrão desta propriedade é falso.

    Tabela 49. Parâmetros
    Nome Tipo Descrição
    bFlag Booliano Sinalizador que indica se uma linha de relacionamento tracejada pode ser desenhada do objeto atual para um novo sucessor.
    Valores válidos:
    • verdadeiro: a linha de relacionamento tracejada pode ser desenhada do objeto atual para um novo sucessor.
    • falso: a linha de relacionamento tracejada não pode ser desenhada do objeto atual para um novo sucessor.
    Tabela 50. Retorna
    Tipo Descrição
    vazio

    TimelineSpan – setInnerSegmentClass(cadeia de caracteres estiloClass)

    Define o nome da classe a ser usada para estilizar o segmento interno, se ele existir.

    Tabela 51. Parâmetros
    Nome Tipo Descrição
    classe de estilo Cadeia de caracteres Nome da classe de cor a ser usada para estilizar o segmento interno.
    Valores válidos:
    • azul
    • verde
    • prata
    Padrão: verde
    Tabela 52. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - setInnerSegmentTimeSpan(Número startTimeMs, Número endTimeMs)

    Cria um segmento interno a ser mostrado dentro do intervalo de tempo atual definido pelo intervalo especificado.

    Tabela 53. Parâmetros
    Nome Tipo Descrição
    startTimeMs Número Hora de início.

    Unidade: Milissegundos
    endTimeMs Número Hora de término.

    Unidade: Milissegundos
    Tabela 54. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - setPointIconClass(cadeia de caracteres iconClassName)

    Define a classe de ícone a ser usada para exibir o elemento atual na linha do tempo se a instância atual tiver duração zero.

    Nota:
    Isso afeta somente o objeto TimelineSpan atual e terá precedência sobre o defaultPointIconClass especificado pelo GlideTimeline.
    Tabela 55. Parâmetros
    Nome Tipo Descrição
    iconClassName Cadeia de caracteres Classe de ícone a ser usada para exibir o elemento atual na linha do tempo se a instância atual tiver duração zero.
    Valores válidos:
    • círculo_preto
    • preto_quadrado
    • círculo_azul
    • azul_quadrado
    • círculo_verde
    • verde_quadrado
    • marco
    • círculo_vermelho
    • quadrado_vermelho
    • círculo_sépia
    • sepia_square
    Tabela 56. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - setSpanColor(cadeia de caracteres strColor)

    Define a cor para exibir este período.

    Tabela 57. Parâmetros
    Nome Tipo Descrição
    strColor Cadeia de caracteres Nome HTML para a cor deste período.
    Tabela 58. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - setSpanText(cadeia de caracteres strSpanText)

    Define o texto a ser exibido ao lado do elemento de tempo.

    Nota:
    Este texto só será exibido se o objeto GlideTimeline tiver habilitado o conjunto de texto da linha do tempo usando o método glideTimeline.showTimelineText(true).
    Tabela 59. Parâmetros
    Nome Tipo Descrição
    strSpanText Cadeia de caracteres Texto a ser exibido ao lado do elemento de tempo.
    Tabela 60. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - setTimeSpan(Number nStartTime, Number nEndTimeMs)

    Define as datas de início e término do período atual.

    Tabela 61. Parâmetros
    Nome Tipo Descrição
    nInícioHora Número Hora de início.

    Unidade: Milissegundos
    nEndTimeM Número Hora de término.

    Unidade: Milissegundos
    Tabela 62. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - setTimeSpan(cadeia de caracteres strStartTime, cadeia de caracteres strEndTimeMs)

    Define as horas de início e de término do período atual.

    Tabela 63. Parâmetros
    Nome Tipo Descrição
    strInícioHora Cadeia de caracteres Hora de início.

    Unidade: Milissegundos
    strEndTimeMs Cadeia de caracteres Hora de término.

    Unidade: Milissegundos
    Tabela 64. Retorna
    Tipo Descrição
    vazio

    TimelineSpan - setTooltip(cadeia de caracteres strTooltipText)

    Define o texto a ser exibido na dica da ferramenta quando o elemento TimelineSpan está sendo posicionado.

    Tabela 65. Parâmetros
    Nome Tipo Descrição
    strTooltipText Cadeia de caracteres Texto a ser exibido na dica da ferramenta.
    Nota:
    Você pode especificar um HTML válido nesta cadeia de caracteres.
    Tabela 66. Retorna
    Tipo Descrição
    vazio