Métodos Lifecycle

Last modified: August 05, 2022

Métodos Lifecycle

O SDK de HTML fornece cinco métodos de ciclo de vida que podem ser usados em uma variedade de padrões para criar ferramentas. Os métodos de ciclo de vida carregam na seguinte ordem:

Configuração definida: Executado quando a ferramenta é clicada. Usado para obter a configuração da ferramenta assim que a ferramenta termina de carregar o HTML.

HTML


    

            SetConfiguration: function (currentToolConfiguration){...}

    SetConfiguration: function (currentToolConfiguration){...}

Parâmetros

configuração do Tool :A configuração da ferramenta a partir da configuração da propriedade. A configuração é conestruturada pela conversão do sistema. Xml.XmlElement para JSON usando o método JsonConvert.SerializeObject da NewstonSoft Json.Net. Veja Json.NET documentação. Consulte arquivo de origem do conversor.

AntesdeCarregar: Executado antes que as lojas de dados sejam carregadas. Usado para configurar manualmente armazenamentos de dados.

XML


    

            window.Alteryx.Gui.BeforeLoad = function (manager, AlteryxDataItems, json) {...}

    window.Alteryx.Gui.BeforeLoad = function (manager, AlteryxDataItems, json) {...}

Parâmetros

manager: Um objeto que implementa as funções SetConfiguration e GetConfiguration, gerenciando itens de dados, seu conteúdo a partir da configuração e sua persistência no fluxo de trabalho. O gerente também:

chama o Window. Função alteryx. gui. Annotation , que fornece uma anotação de Canvas de fluxo de trabalho para sua ferramenta retornando uma cadeia de caracteres.
interage com os widgets HTML GUI SDK.
fornece uma API fácil para acessar informações de campo e ferramenta upstream.

A API completa do gerente é detalhada na documentação de referência da API.

AlteryxDataItems: Um objeto com vários construtores do tipo item de dados nele, para que você possa renovo-los a partir dele. Para obter a lista completa de itens de dados com suporte, consulte itens de dados com suporte.

HTML


    

            new AlteryxDataItems.SimpleInt('X')

    new AlteryxDataItems.SimpleInt('X')

json: Um objeto contendo o JSON real que fornece os dados de configuração atuais da ferramenta. Os dados de configuração XML persistentes reais estão o Configuration Propriedade. A descrição curta do objeto é:

XML


    

            {
	MacroMode: bool,
	IsFirstConfig: bool,
	IsNoConfig: bool,
	Configuration: object,
	MetaInfo: array of object,
	ToolId: int,
	ToolName: string
}

    {
	MacroMode: bool,
	IsFirstConfig: bool,
	IsNoConfig: bool,
	Configuration: object,
	MetaInfo: array of object,
	ToolId: int,
	ToolName: string
}

AfterLoad: Executado após a carga das lojas de dados. Usado para disparar a lógica do aplicativo. Recupera valores de itens de dados depois que o Gerenciador tiver carregado valores da configuração XML de entrada.

XML


    

            window.Alteryx.Gui.AfterLoad = function (manager, AlteryxDataItems) {...}

    window.Alteryx.Gui.AfterLoad = function (manager, AlteryxDataItems) {...}

Parâmetros

Manager: um objeto que implementa as funções SetConfiguration e GetConfiguration , gerenciando itens de dados, seu conteúdo da configuração e sua persistência no fluxo de trabalho.

O gerente também:

chama o Window. Função alteryx. gui. Annotation , que fornece uma anotação de Canvas de fluxo de trabalho para sua ferramenta retornando uma cadeia de caracteres.
interage com os widgets HTML GUI SDK.
fornece uma API fácil para acessar informações de campo e ferramenta upstream.

A API completa do gerente é detalhada na documentação de referência da API.

XML


    

            new AlteryxDataItems.SimpleInt('X')

    new AlteryxDataItems.SimpleInt('X')

XML


    

            {
	MacroMode: bool,
	IsFirstConfig: bool,
	IsNoConfig: bool,
	Configuration: object,
	MetaInfo: array of object,
	ToolId: int,
	ToolName: string
}

    {
	MacroMode: bool,
	IsFirstConfig: bool,
	IsNoConfig: bool,
	Configuration: object,
	MetaInfo: array of object,
	ToolId: int,
	ToolName: string
}

AfterLoad: Executado após a carga das lojas de dados. Usado para disparar a lógica do aplicativo. Recupera valores de itens de dados depois que o Gerenciador tiver carregado valores da configuração XML de entrada.

XML


    

            window.Alteryx.Gui.AfterLoad = function (manager, AlteryxDataItems) {...}

    window.Alteryx.Gui.AfterLoad = function (manager, AlteryxDataItems) {...}

Parâmetros

Manager: um objeto que implementa as funções SetConfiguration e GetConfiguration , gerenciando itens de dados, seu conteúdo da configuração e sua persistência no fluxo de trabalho.

O gerente também:

chama o Window. Função alteryx. gui. Annotation , que fornece uma anotação de Canvas de fluxo de trabalho para sua ferramenta retornando uma cadeia de caracteres.
interage com os widgets HTML GUI SDK.
fornece uma API fácil para acessar informações de campo e ferramenta upstream.

A API completa do gerente é detalhada na documentação de referência da API.

Alteryxdataitems: um objeto com vários construtores de tipo de item de dados nele, para que você possa novos-los a partir dele. Para obter a lista completa de itens de dados com suporte, consulte itens de dados com suporte.

HTML


    

            new AlteryxDataItems.SimpleInt('X')

    new AlteryxDataItems.SimpleInt('X')

AntesGetConfiguration: Executado antes do evento GetConfiguration ser disparado. Permite que os dados de configuração atuais sejam alterados antes de obter a configuração da ferramenta na deseleição. Usado para alterar os valores ou a estrutura dos dados persistentes.

XML


    

            window.Alteryx.Gui.BeforeGetConfiguration = function (json) {...}

    window.Alteryx.Gui.BeforeGetConfiguration = function (json) {...}

Parâmetros

XML


    

            {
	MacroMode: bool,
	IsFirstConfig: bool,
	IsNoConfig: bool,
	Configuration: object,
	MetaInfo: array of object,
	ToolId: int,
	ToolName: string
}

    {
	MacroMode: bool,
	IsFirstConfig: bool,
	IsNoConfig: bool,
	Configuration: object,
	MetaInfo: array of object,
	ToolId: int,
	ToolName: string
}

GetConfiguration: executa como a ação final antes que uma ferramenta seja desmarcada, obtém a configuração da ferramenta do GUI.

XML


    

            GetConfiguration: function () {...}

    GetConfiguration: function () {...}

Padrões de criação de interface do usuário

Existem vários métodos disponíveis para a criação de uma ferramenta. Avalie o que seus usuários exigem de sua ferramenta antes de determinar qual método de criação você deseja usar.

Se a ferramenta estiver preenchendo uma interface do usuário existente, ele não precisará persistir a configuração entre os usos. Se a ferramenta tem definições de configuração que persistem, mas não são exibidas para um usuário, a ferramenta não precisa sincronizar dados entre controles de interface do usuário e a persistência de configuração.

Padrão de criação da interface do usuário	A ferramenta carrega e persiste automaticamente sua configuração	Ferramenta sincroniza automaticamente dados entre controles de interface do usuário e persistência de configuração
Use apenas setConfiguração e Configuração de get	Não	Não
Use antescarregar e pós-carga com itens de dados	Sim	Não
Usando itens de dados com widgets	Sim	Sim