FactSet.SDK.ChartGenerationService
0.21.11
Prefix Reserved
dotnet add package FactSet.SDK.ChartGenerationService --version 0.21.11
NuGet\Install-Package FactSet.SDK.ChartGenerationService -Version 0.21.11
<PackageReference Include="FactSet.SDK.ChartGenerationService" Version="0.21.11" />
paket add FactSet.SDK.ChartGenerationService --version 0.21.11
#r "nuget: FactSet.SDK.ChartGenerationService, 0.21.11"
// Install FactSet.SDK.ChartGenerationService as a Cake Addin #addin nuget:?package=FactSet.SDK.ChartGenerationService&version=0.21.11 // Install FactSet.SDK.ChartGenerationService as a Cake Tool #tool nuget:?package=FactSet.SDK.ChartGenerationService&version=0.21.11
Chart Generation Service client library for .NET
This is a service for generating charts in a node environment that were created using web charting and get back images in form of PNGs
and JPEGs
as response.
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 1.5.0
- SDK version: 0.21.11
- Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
- .NET Standard >= 2.0
Installation
.NET CLI
dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.ChartGenerationService -v 0.21.11
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.ChartGenerationService -Version 0.21.11
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- Run the following:
[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
Example Code
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.ChartGenerationService.Api;
using FactSet.SDK.ChartGenerationService.Client;
using FactSet.SDK.ChartGenerationService.Model;
namespace Example
{
public static class GetCategoryListExample
{
public static async Task Main()
{
var config = new FactSet.SDK.ChartGenerationService.Client.Configuration();
// Examples for each supported authentication method are below,
// choose one that satisfies your use case.
/* (Preferred) OAuth 2.0: FactSetOAuth2 */
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-dotnet#authentication
// for more information on using the ConfidentialClient class
ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
config.OAuth2Client = confidentialClient;
/* Basic authentication: FactSetApiKey */
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// config.Username = "USERNAME-SERIAL";
// config.Password = "API-KEY";
var apiInstance = new ChartTemplatesApi(config);
try
{
// Get a list of chart categories
List<string> result = apiInstance.GetCategoryList();
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling ChartTemplatesApi.GetCategoryList: " + e.Message );
Console.WriteLine("Status Code: "+ e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
}
Using a Proxy
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/charting/v1
Class | Method | HTTP request | Description |
---|---|---|---|
ChartTemplatesApi | GetCategoryList | GET /catalog/categories | Get a list of chart categories |
ChartTemplatesApi | GetChartList | GET /catalog/charts | Get a list of chart templates that can be used for getting the image from the service. |
ChartTemplatesApi | Images | GET /image | Get chart image back in PNG or JPEG formats |
Documentation for Models
- Model.CategoriesErrorResponse
- Model.CategorizedChartList
- Model.CategoryChartListErrorObject
- Model.CategoryListResponse
- Model.ChartErrorResponseObject
- Model.ChartInput
- Model.ChartList
- Model.ChartListErrorResponse
- Model.ErrorResponse
- Model.UnauthorizedResponse
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2022 FactSet Research Systems Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- FactSet.SDK.Utils (>= 1.0.0)
- JsonSubTypes (>= 1.8.0)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 7.2.2)
- RestSharp (>= 106.15.0)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.21.11 | 93 | 8/30/2024 |
0.21.10 | 82 | 7/11/2024 |
0.21.9 | 120 | 4/10/2024 |
0.21.8 | 258 | 10/25/2023 |
0.21.7 | 162 | 8/30/2023 |
0.21.6 | 170 | 8/11/2023 |
0.21.5 | 165 | 6/6/2023 |
0.21.4 | 155 | 5/11/2023 |
0.21.3 | 231 | 3/1/2023 |
0.21.2 | 258 | 2/24/2023 |
0.21.1 | 386 | 8/31/2022 |
0.21.0 | 394 | 7/21/2022 |
0.20.0 | 430 | 5/24/2022 |
0.9.1 | 413 | 2/14/2022 |
0.9.0 | 437 | 2/2/2022 |
Refer to Changelog on GitHub source repository